Situationsbeschreibung
Ihr Chef überträgt Ihnen die Aufgabe für ein Softwareprodukt Ihrer Agentur das Handbuch zu schreiben. Um diese Aufgabe möglichst professionell durchzuführen, recherchieren Sie zu diesem Thema in der Bibliothek. In einem Buch lesen Sie folgenden Text:
Writing User Guides
A user guide (or manual) contains instructions on installing, using, or troubleshooting a hardware or software product. User guides are not only written for computer hardware or software, but can provide operating instructions on practically anything—microwave ovens, dishwashers, televisions and so on.
The more complex the product, the greater the page count. When including many pages, the elements of the user guide should be split into separate volumes, especially the installation procedures and troubleshooting procedures. A user guide can even contain a brief tutorial, for example, getting users started using the product.
Style and Format for User Guides
A good writing style and knowledge on instruction writing is a requirement for good user guides. It is important to use different ways to structure the text to make it readable: headings, lists, notices, highlighting, tables, graphics commonly used in instructions.
- Headings: Use headings to mark off key contents of the information so that readers can find it quickly.
- Lists: Use numbered and bulleted lists to help readers scan information quickly.
- Special notices: Use special notices such as warnings, cautions, and notes to alert readers to potential problems or emphasize special points.
- Graphics: Show readers key components of the objects they will be working with, before and after views, and illustrations of key actions that readers must perform.
- Tables: Provide statistical information and other such details in easy-to-access table form. In user guides, tables are particularly useful whenever reference-type information must be presented.
- Highlighting: Use a consistent and standard scheme of highlighting (bold, italics, alternate fonts, color, caps, and so on).
Beschreiben Sie in deutscher Sprache was Sie beim Schreiben des Handbuchs beachten müssen. Dabei übersetzen Sie den Text nicht, sondern formulieren in eigenen Worten.