Looking for links to resources that will help me write a user guide for a software application. I'm after something that will help me to structure my guide, give it an appropriate writing style, and ensure that it has an excellent look and feel throughout.
views:
2015answers:
4
+2
A:
This link has some strong points. Each point is presented with clear speech and with inline justifications.
When writing procedures, use the active voice (e.g. Click this) and address users directly (write "you" rather than "the user").
When explaining an action, use the "command" form of the verb:
"Choose an option from the menu and press [ENTER]."
http://www.klariti.com/technical-writing/User-Guides-Tutorial.shtml
Here is the complete list of the topics covered on the aforementioned article:
- Front Page (cover pages)
- Cover and Title Page
- Disclaimer
- Preface
- Contents
- Body of the guide
- Procedures
- Writing procedures
- Chunking text
- Number your steps
- Using the If-Then Approach
- Reference Materials
- Back Matter
- Glossary
- Index
- Establishing Standards
- Document Format
- Structure Style
- Technical Language
- Addressing the User
- Presenting your material
- Special Requirements
smink
2008-10-20 12:37:53
+1
A:
For structure and look+feel, consider using a framework such as DocBook.
DocBook uses an XML markup schema that makes you think about how your document should be arranged. There are XSL transformations to convert it to common formats like HTML and PDF with a whole load of config options to make it look the way you want. And it's open-source (free). There are downsides of course: the schema's pretty big, and editing can be hard work without a good XML editor.
jrb
2008-10-20 17:08:56
A:
I found some templates here, hope this helps - Free User Guide Template - The App Times
Richard
2010-09-02 15:54:39