[wp-docs] Doc Submission Proposal

[Cena]

Okay, just to kick off with some practical guidelines, I submit the following for your 
perusal/critique.  Borrowed from similar guidelines proposed during my stint in the 
Postnuke pnCorps documentation team.

Submission Guidelines Proposal, 14 November 2003

Format 

Final user documentation should be authored using the [X] format. : 
 
If you submit a final version then it will be reviewed based on the 
requirements below and initially published online. 

Be sure to include title information on the cover of each document. 

Requirements 

All documents submitted and accepted to the project are licensed under the 
following guidelines: http://creativecommons.org/licenses/by-nc-sa/1.0/ 
Quote:

Attribution. You must give the original author credit. 
Noncommercial. You may not use this work for commercial purposes. 
Share Alike. If you alter, transform, or build upon this work, you may distribute 
the resulting work only under a license identical to this one


[OR:  GPL?]

All documents should have a title page in a consistent format. The title page 
of each document contains organization name, product logo, product name, 
product version and manual name and the date of document issue, its 
intended audience (or audience subset, if appropriate); a brief list of expected 
audience competencies; a brief statement of the overall task(s) and what each 
user audience member is expected to perform; a brief statement of the 
document's purpose; each document's usage mode and orientation; and cross-
references to any associated documents. 

You should provide a core of documentation that completely documents 
every aspect of the users' interactions with the system. If the reader is directed 
outside the documentation then appropriate details should be provided. 

The information included in the user documentation shall be accurate. This 
includes email addresses, URLs, copyrights, trademarks, references (as 
appropriate). 

The documentation should only contain material relevant to the use of  
WordPress and directly address its intended audiences, i.e., end users, site 
admins and programmers. 
Correct grammar and consistent voice or writing style is very important. 
Please see the following for examples and suggestions: 
http://owl.english.purdue.edu/handouts/index2.htmlhttp://www.westwords.co
m/guffey/reviews.html 
http://www.ccc.commnet.edu/grammar/  

You should include appropriate cross-referencing features, such as: page 
numbers, tables of contents, lists of figures, lists of tables, glossaries, indexes, 
and bibliographies. If you make references to external docs, these should be 
included in the bibliographies and referred to in the body of the text. Internal 
references to objects (such as figures, tables, sections) elsewhere in the 
document (other than on the same page as the reference) should be associated 
with a page number. 

Accurate diagrams and illustrations can be used in appropriate places, and the 
format should be consistent throughout the document. They should be 
numbered, captioned, and readable, and include text labels and legends.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://socrates.scdns.net/pipermail/docs_wordpress.org/attachments/20031114/0640a5a2/attachment.htm