Practical requirements for documents
1. Document is not only for customers, but also the experience summary of our project implementation;
2. Documentation must be practical, for customers, for us!
What kind of document is practical?
1. The purpose is clear
a) Document is definitely a description of a certain type of problem, so it is required to be clear and targeted. For example, if only one of the versions of a module is, it will never be ambiguous, but in a significant place to explain, it will never waste the user / reader.
2. Clear
a) To reasonably arrange the chapter as much as possible.
b) Clear: What is it? why? How to do it? When several issues, if necessary, need to add "who?" "When? Where? What is the situation?" And so on.
3. Consistency
a) The relevant content that appears in the text should be consistent before and after, and it is not self-contradictory;
4. Content is enriched
a) In order to describe some questions, there should be some things that don't quit;
b) If there is no such thing as something, it should be stated that "content needs to be refined / supplement";
5. Operability
a) If the document is characterized by the operation, you should be able to verify your article on the authenticity of the content. The reader can complete a certain job according to the prompt of the document;
b) Documentation should provide visual pictures or other media methods as much as possible, so as can be intuitive, it is easier to understand;
6. Thoughtful
a) Incidents in the text, you should provide links as much as possible, so as not to search for all walks of search frequencies;
