[wp-docs] Document Standards - Constants, Variable Names

[Matt Mullenweg]

http://wiki.wordpress.org/index.php/DocumentationConventions

Carthik A Sharma wrote:

> Hi All,
> Can one of the coords or devs please put up a list of terms to be used 
> in the documents.
> Like
> http://example.com/ is the "Root URI"
> http://example.com/wordpress/ is where wordpress is installed - "WP Root 
> URI"
> admin - always the administrator
> simplejoe - always the user no admin privileges
> 
> and other such. So that the terms used in all docs are the same?
> I would love to have a reference, when I write a doc, as to what 
> term/tag/name to use to describe a variable (I mean like the blog URI) 
> in layman's terms.
> 
> My suggestion is that we have an extensible documentation system, by 
> giving folks to write the HowTos they want to, and then probably linking 
> to the longer Howtos from a central FAQ.
> Example:
> ...
> How Do I upgrade?
> Please see the [link]->Upgrading HowTo.
> 
> That would help us have more questions on a shorter, smaller page, and 
> the FAQ, or list of Howto could be the central Document.
> 
> Thanks,
> Carthik.
> 
> 
> ------------------------------------------------------------------------
> 
> _______________________________________________
> docs mailing list
> docs at wordpress.org
> http://wordpress.org/mailman/listinfo/docs_wordpress.org


-- 
--Matt
http://photomatt.net | http://wordpress.org