208
edits
Difference between revisions of "Doc Sprint/Application/2013"
Jump to navigation
Jump to search
Doc Sprint/Application/2013 (view source)
Revision as of 10:56, 9 August 2013
, 10:56, 9 August 2013→Projects only: Propose a topic of the Book Sprint and outline in a few sentences what you would like to cover.
| Line 48: | Line 48: | ||
==Projects only: Propose a topic of the Book Sprint and outline in a few sentences what you would like to cover.== | ==Projects only: Propose a topic of the Book Sprint and outline in a few sentences what you would like to cover.== | ||
- [[how to write | - [[how to write documentation for a massively cross-platform product]] | ||
Our product runs on more than 30 platforms. What are the best practices and obvious | Our product runs on more than 30 platforms and even more disparate form factors. What are the best practices and obvious pitfalls when you write documentation for massively cross-platform products? | ||
- [[how to write documentation for reimplementations/emulators/etc]] | - [[how to write documentation for reimplementations/emulators/etc]] | ||
| Line 58: | Line 58: | ||
- [[how to keep documentation up to date for a constantly evolving open source project]] | - [[how to keep documentation up to date for a constantly evolving open source project]] | ||
One of the issue we encountered with our previous effort to write a user manual was to keep it updated when releasing a new version of the software with changes in the GUI, new options, support for new games... What are the best practices to ease that effort? | One of the issue we encountered with our previous effort to write a user manual was to keep it updated when releasing a new version of the software with changes in the GUI, new options, support for new games... What are the best practices to ease that effort? How do people overcome the needs for formal documentation against the needs for living documentation. How can the team structure and expectations help with these issues? | ||
==Will you (or anyone you listed before) be attending the 2013 GSoC mentor summit? (Yes/No/Not Sure)== | ==Will you (or anyone you listed before) be attending the 2013 GSoC mentor summit? (Yes/No/Not Sure)== | ||
Not Sure | Not Sure | ||