Therefore, use more lists online than you would on a typical printed page.Īvoid having more than nine items in a list. To emphasize main points limit each paragraph to one idea and do not write more than three to five sentences per paragraph (or a maximum of 75 words).īulleted and numbered lists help to break up hard-to-read screen text and provide white space that gives the eyes a visual break. These belong in Guides, but not in How Tos. For the same reason you should place the most important words first, and avoid starting headings with an article.ĭo not go beyond fourth-level headings and try to have at least two headings at each level.Īvoid headings such as "Overview" or "Introduction". Headings and subheadings should be short, precise abstracts of the associated content because they are often displayed out of context and may be truncated in search results lists. Write meaningful headings and subheadings.To structure your documents accordingly, do the following: Scannable documents help readers to locate information quickly. Readers are goal oriented and scan for information. The guidelines in this section are particularly important for writing online documents. This style guide focuses on How Tos in the Documentation Wiki.
0 kommentar(er)
