The following sets the basic requirements when formatting your documentation article.

References

Guidelines for Contributors

Glossary of Terms

Overview Pages

An article that introduces a section with introductions and links to subsections.

Introduction paragraph

Links to sections with brief descriptions

• Use an indent to format each link
• Link is identical to how it appears in the menu.
• Link is followed by an emdash (space-emdash-space) and then a one or two sentence introduction to the subsection describing how it expands upon the overall subject.

Summary paragraph relates the section back to the category, i.e. relates a content management subject back to Content Management.

Linking to a Subsection

Subsection links

Headings

Title Case

Capitalize

• The first and last word (always)
• Nouns, verbs, adjectives, adverbs
• Words of 4+ letters (common rule of thumb)

Lowercase

• Short prepositions: in, on, at, by, for, of, up, to
• Articles: a, an, the
• Short conjunctions: and, but, or, nor, so, yet

Example

A Guide to the Rules of Title Case and How to Use Them

Ampersand &

Use in menus only as a substitute for the word "and", but never in article titles.

Menu Item

6 Pagination & Read More

Article Title

6 Pagination and Read More

Numbering

When content follows a numbered outline or index structure, do not add periods at the end of a number.

Yes

6 Pagination and Read More

No

6. Pagination and Read More

Tags

• Tutorial
• Content Management
• Site Building
• Site Maintenance

Screenshots

Refer to Tips for Better Screenshots for detailed guidance.

Notes: 1500–2500px width; light (not dark) browser background; crop appropriately to orient the user and display relevant details; browser zoom to enhance text; PNG file format.

Captions

When configured with a caption (right-click and check the caption box) the image is wrapped in a <figure> block with proper captioning; otherwise the image is displayed in a standard inline condition.

Placement

Size

Standard widths: 960px for full width, and 320px or 640px for partial widths.

Large widths (greater than 1000px) are automatically resized in the browser to the article width. Smaller images are left justified.

Attribution

If the screenshot includes images, should we attribute the source? And how?