[wp-docs] Adding Administration Menus
carthik at gmail.com
Wed Mar 9 05:52:06 GMT 2005
I spent a good part of the last hour looking for a set of guidelines
for developing documentation for web-based application UIs. I got
The gnome project comes close in defining standards in a document that
describes how to refer to various elements.
Usually, the good thing about standards is that there are so many to
choose from - but not in our case. So what do you say to we develop a
standard vocabulary to refer to various elements in the WordPress UI,
and nail them down in the Glossary, or in the codex_guidelines and
stick to it, from now on?
Michael, I wrote up 90% of the doc required for 1.2's UI, till the
complexity and the inanity got me. Repeating obvious things, and
things that are already in text on the UI helps no one, so the
challenge would be to answer the "why"s and "why not"s, rather than
just the "what"s of various things - if you are creating UI based
documentation. That is one reason I haven't really spent time reading
the pages you wrote up, cause they can suck up a whole lot of time,
and still be of little use to people - no one will want to know what
some button is, a few will want to know why it is there, or why it's
required, and not something else. A lot of people arrive at the Codex
with a specific "how to" in mind. We should suck them in, and give
them more info than what they came looking for - and hence, task-based
docs that reference the UI docs will be cool to have.
Point of this mail - decide nomenclature for different elements before
proceeding, to preserve order.
As for your page's name, I am glad to see the newly created page!
On Tue, 08 Mar 2005 18:25:05 -0700, Craig Hartel <craig at nuclearmoose.com> wrote:
> I like panels over pages.
> wp-docs mailing list
> wp-docs at lists.automattic.com
When nothing is done, nothing is left undone -- 老子 Lǎozi
University of Central Florida
More information about the wp-docs