Itqualityassurance
- Why it is important to produce documentation that is user friendly?
- What are the differences between user documentation and system documentation What is their usefulness?
- What should be included in user documentation?
Why it is important to produce documentation that is user friendly?
User-friendly language and content in the document contribute to the user's ability to understand the information presented and to apply that information as intended.
What are the differences between user documentation and system documentation What is their usefulness?
System documentation represents documents that describe the system itself and its parts. It includes requirements documents, design decisions, architecture descriptions, program source code, and FAQs. User documentation covers manuals that are mainly prepared for end-users of the product and system administrators.
What should be included in user documentation?
Great user documentation should include: Plain language, simplicity, visuals, a focus on the problem, a logical hierarchy and flow, a table of contents, searchable content, accessible content, good design, feedback from real users, and links to further resources.
