Difference between revisions of "Documentation"
From Dreamwidth Notes
| Line 10: | Line 10: | ||
* [[Guides ideas]] -- Ideas and suggestions for guides we might want to write. | * [[Guides ideas]] -- Ideas and suggestions for guides we might want to write. | ||
* [[FAQ mockup]] -- rough mockup of how the general structure of the FAQ may look. | * [[FAQ mockup]] -- rough mockup of how the general structure of the FAQ may look. | ||
| + | * [[FAQ backend guide]] | ||
[[Category: Documentation]] | [[Category: Documentation]] | ||
Revision as of 11:06, 26 January 2009
Documentation is like sex: when it is good, it's very very good, and when it's bad, it's better than nothing.
The DW documentation project has three parts: user documentation (FAQ, user manual, etc), site copy (messaging on the site), and server documentation (instructions on how to install and maintain the code). Here is where we put useful links about this process.
- Manual of Style -- the in-house manual of style for all site copy and documentation
- dw-docs -- Mailing list for discussion of all aspects of the documentation project.
- Consistency in naming -- discussion of which name to use for things when there are multiple possibilities.
- Documentation related zilla items
- Pending Tasks
- Guides ideas -- Ideas and suggestions for guides we might want to write.
- FAQ mockup -- rough mockup of how the general structure of the FAQ may look.
- FAQ backend guide
