[drupal-docs] Drupal Handbook Authoring Standards
Charlie Lowe
cel4145 at cyberdash.com
Sat Jan 8 21:48:38 UTC 2005
bryan on the web wrote:
> Okay, I made some changes to the document based on comments. If you can
> view the Drupal page it is still:
> http://drupal.org/node/15289
>
Looks great :)
One comment. There's an assumption in the following that the
documentation entries might only need one level of headings:
"For longer handbook entries, please break your explanation up into
sections. At the beginning of each section provide a title which should
be enclosed within <h3> tags."
I suggest changing it to something like
"For longer handbook entries, please break your explanation up into
sections and subsections using headings and subheadings. Headings and
subheadings should make use of titles enclosed in <h2>, <h3>, etc.
respectively." (or <h3>, <h4>, etc., depending on the outcome of the h2
vs h3 discussion; +1 for h2).
Also, headings and subheadings don't typically need colons following
after them. The typographical emphasis provided by the h tags is enough.
Charlie
More information about the drupal-docs
mailing list