Creating Documentation

Documentation is part of the workflow cycle. Creating documentation is not an easy job. Here are some tips you can do to make your job documentation.

1. Include Image
Use the picture as a supplementary text to minimize the length and complexity of your document. User system love to see pictures, diagrams, tables, and lists in the form of bullet points for quick reference.

2. Give examples
Examples are the appropriate way for end users to learn new software to be more easily understood.

3. Do not make assumptions
At the time documentation, place yourself as a new user. Documentation must be written in such a way, step by step instructions and placed in the appendix, a separate chapter, so do not look messy.

4. Anticipate Problems
Document how to overcome the problem and give to the users and help desk. Document the events that sometimes occur during the use of the system. Documentation that you create must be to anticipate problems and provide detailed plans and instructions for system recovery.

5. Review Documentation
Take time to review your documentation. The first review takes the issue of "macro", such as structure, style; second review takes the issue of "micro" is more specific as to the issue of a sub-section.

6. Humanize Documentation
Make your documentation so that the reader will be more comfortable at the time to read it.

7. New Technology Exploration
Use of new technologies in manufacturing documentation to reduce costs and improve effectiveness.

8. Create Own Documentation If Allows
If you are making system, then make up your own documentation for your system because you know best about the system that you create.

9. Synchronization Documentation
You can reduce the time the documentation if you make the End User Documentation with the System Documentation. You can exchange information between them and reduce the missing information.

10. Follow the Standard Documentation Guide
Create and follow standard formatting guidelines. This will assist in ensuring that no important information missing that facilitate reading by the user.