Writing assignment 6
Writing assignment 6: Rewriting your instructions (will replace grade 4).
Rewrite and recode your instructions, observing the following principles:
Writing
Note: Pay special attention to YSG chapter 7 on writing user interface text and chapter 11 on capitalization)
- Begin with a title (use title case).
- After the title, add an explanatory paragraph or two that contains an overview of the instructions and their purpose and audience. If the instructions assume knowledge or possession of a certain skillset or software package, explain that too.
- Group instructions into steps of no more than five. Use subheadings (sentence case or "down style"). Number all steps,and do not number anything that isn't a step.
- Use consistent language for menu items, buttons, text boxes, radio text, etc. Example: use "choose" for menu items, "select" for radio items, and "type" or "type in" for text boxes.
- Use the imperative mood for all steps. Make bulleted or numbered items parallel.
- Be consistent about punctuating styles.
- When you have made an illustration that illustrates your step, clearly label that illustration and refer to it in your step (example: See figure 1: Setting up a free site).
- Avoid passive voice and expletive constructions.
- Because these instructions will look funny in Internet Explorer, add an explanation about which browsers work best (choose browsers that can read figures/ captions).
- Make sure that a step,not an image, ends the instructions.
Coding
- Create a container div to control the width of your page (see styling, below).
- Each group of instructions should be in its own div, and each div should have its own unique id.
- You should use "figure" and "figcaption" to label illustrations. (These won't work unless they are contained inside divs).
- For illustrations, use alt text to clearly label each image. Use the "width" property to make sure your images have a consistent width and don't fill up too much of the page.
Styling
- Make your container no more than 80% of the page or give it a fixed width of no more than 900px.
- Each div should be the same width.
- Float images next to the instructions they illustrate.
- Make sure images have borders.
- Center figure captions under pictures.
- Create "span" styles (classes) for buttons, menu items, text entry, windows, and notes so readers will be able to tell the difference.
Illustrations
- When labeling screen shots, make sure your arrows have a consistent look and color. Choose fonts that will contrast with the fonts on the screen shot.