From Hdwiki
StyleGuide:Documenting Instructions
[edit]
Documenting Instruction Guidelines
There is a specific type of style and formatting that you should use when you create documentation. If everyone uses this style, then it will create a consistent, singular look. Therefore, this makes it easy for the general public to follow and understand the text.
[edit]
Tips on Creating Effective Documentation
- Use the numbered list when you are creating step-by-step instructions. Each step should be contained within its own number.
- Use bullets only for lists and tips. Use paragraphs only for introductions, conclusions, definitions, notes, etc.
- Use '''bold formatting''' when you are describing any named menu items, buttons, links, titles, etc.
Example: To copy text in Microsoft Word, go to Edit, Copy.
- List items, buttons, links, titles, etc. exactly as they appear to avoid confusion.
Example: In Word, if I wanted someone to go to Edit, Find, I would list it as Edit, Find… (note the three periods, also known as an ellipse, at the end of "find") since that is exactly how it would appear to the user.
- People "go to" menus, "click" on buttons, links, and tabs, and "select" or "deselect" folders, boxes, and radial buttons.
Example: To turn off picture boundaries, go to Tools, Options… Under the View tab, deselect the Picture placeholders check box. Click on the OK button.
- List ALL of the steps involved in the task. Do not assume that people will automatically perform obvious steps. If the user will need to click the OK button twice in a row, include it in the instructions.
Bad example: To turn off picture boundaries go under the Tools menu and then choose Options. Then, choose Picture placeholders.
- Every article must begin with a Category listing. i.e. [[Category:CategoryName]]
- Article titles should not be retyped at the top of the body since it is already displayed at the top of the page.
- Sections within the body of articles should begin with h2 (==heading2==) and continue down from there. (h1 is reserved for administrator use).
[edit]
Mark for Edit
- If you feel an article should not exist on our wiki, add {{delete}} to the top of the article, and then describe on the Discussion page why you feel the article should be deleted.
- If you feel an article should be moved to a different location, add {{move}} to the top of the article, and then describe on the Discussion page why you feel the article should be moved.
