online documentation
Answer question about online documentation
Choose one of the following question to answer:
- Share an example of an online help system that you think is written and organized exceptionally well. Explain what makes this example of online help writing so great.
- Share an example of an online help system that you think is written and organized exceptionally poorly. Explain what makes this example of online help writing so bad.
Answer preview
The hardest part of writing online documentation is determining what type of online content to provide to users and its usability. This is because users work with online documents in different contexts and for numerous purposes. Since the online document has a narrow focus, determining the document’s usability, readability and maintainability become complicated. This means the process requires planning, designing, and evaluation. In the planning stage, conducting a need assessment helps to identify internal and external requirements of online documentation. However, designing online documentation to match users` needs is easier. This is because developers only need to cross-link their interests with their customers` to develop comprehensive online documentation.(356words)
