[wp-docs] Document Standards - Constants, Variable Names
Carthik A Sharma
mail at carthik.net
Fri Apr 16 11:31:24 CDT 2004
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.
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 187 bytes
Desc: OpenPGP digital signature
Url : http://socrates.scdns.net/pipermail/docs_wordpress.org/attachments/20040416/1d7e401a/signature.bin
More information about the docs
mailing list