|
The enhancements that we make when updating existing documents add significant value to the content and also create a
suitable platform for further updates.
Possible content enhancements include:
Design a style sheet and templates
- Use a consistent, common format.
- Use defined styles for text, bulleted lists and numbered lists.
- Automatically generate the Table of Contents.
Apply the Information Mapping ® principles
- Introduce bulleted lists and numbered steps for procedures where applicable.
- Assemble content in labeled chunks of related information.
- Tabulate information where necessary.
- Add appropriate headings and labels.
Edit and simplify the language used
- Simplify the language, making it consistent, clear and unambiguous.
- Rewrite sections containing 'jargon' where relevant and appropriate.
- Ensure that the targeted readers can understand the language that is used.
Improve the usability of the content
- Make the topics and the content in the manual easy to find and use by introducing appropriate heading levels, labels, and an index containing
the relevant keywords.
- Create flow charts that are easy to follow, and that compliment the written procedures and examples.
- Include a glossary of the terms used.
|