Difference between revisions of "Documentation"

From Dreamwidth Notes
Jump to: navigation, search
(4 intermediate revisions by 2 users not shown)
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.
+
There's a lot of information in the documentation category. Discussion mostly takes place on <dwcomm>dw_docs</dwcomm>.
  
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
 
* [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]]
 
  
 
[[Category: Documentation]]
 
[[Category: Documentation]]

Revision as of 20:53, 18 July 2016

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