Difference between revisions of "Documentation"

From Dreamwidth Notes
Jump to: navigation, search
Line 1: Line 1:
 
Documentation is like sex: when it is good, it's very very good, and when it's bad, it's better than nothing.
 
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.
+
There's a lot of information in the documentation category. Discussion mostly takes place on <dwcomm>dw_docs</dwcomm>.
  
* [[Manual of Style]] -- the in-house manual of style for all site copy and documentation
+
The documentation project is run by [[user:rho|rho]] who is not currently looking for further volunteers. She expects to expand the number of people working on documentation after Open Beta. If you're interested in helping out, keep an eye on <dwcomm>dw_docs</dwcomm>.
* [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.
+
* [[Documentation related zilla items]]
+
* [[Documentation/Pending Tasks|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]]
+
* [[Userdoc team]]
+
* [[Site copy team]] -- now accepting applications!
+
  
 
[[Category: Documentation]]
 
[[Category: Documentation]]

Revision as of 19:48, 16 April 2009

Documentation is like sex: when it is good, it's very very good, and when it's bad, it's better than nothing.

There's a lot of information in the documentation category. Discussion mostly takes place on [info]dw_docs.

The documentation project is run by rho who is not currently looking for further volunteers. She expects to expand the number of people working on documentation after Open Beta. If you're interested in helping out, keep an eye on [info]dw_docs.