Difference between revisions of "Documentation"
From Dreamwidth Notes
Zvi-likes-tv (Talk | contribs) (added link to mailing list) |
|||
| Line 5: | Line 5: | ||
* [[Manual of Style]] -- the in-house manual of style for all site copy and documentation | * [[Manual of Style]] -- the in-house manual of style for all site copy and documentation | ||
* [http://lists.dwscoalition.org/cgi-bin/mailman/listinfo/dw-docs dw-docs] -- Mailing list for discussion of all aspects of the documentation project. | * [http://lists.dwscoalition.org/cgi-bin/mailman/listinfo/dw-docs 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. | ||
[[Category: Documentation]] | [[Category: Documentation]] | ||
Revision as of 22:12, 11 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.
