Little experience in writing documentation

xiaoxiao2021-03-06  73

Has been, the teacher's family, the family, said that they are particularly smart and have a good memory; and they always think so, because this is the fact, but also confident, almost anything in the head - the note, I will The speech, the public speech is also a fullness, and all the contacts of the phone number are in the mind, it is very good. However, people, over time, a lot of things will be forgotten, or it is called "new metabolism". It is normal. When you have a moment, once you forget something, you will always remember it, you will feel that people's memory is briefly. I don't know when, I am used to writing my own things in a specific book, and now I have more than 10 books, there is a program, there is a database, there is a network, there is The development experience, there is a sense of life, and so on, it records the wind and rain in recent years. Every book is full of heart, accidentally lost a bit, and I can't eat a few days. It is like a writer to write this book, and the result is not published, and you make him a word, it is too difficult to write, it is too difficult. Develop a small software, be sure to indicate the time, function, etc., if the time is long, it will be used immediately. Especially this kind of small software is more, don't use it for 3 days, you will be born when you use it. If you are doing customer service, there will be no customers call for a few days, and you will feel floating. The developer cannot separate is a document - the demand manual, the overall design manual, the detailed design manual, etc. A good project development team, its document must be very detailed. Because you can't stay in a company in a lifetime, the software is not possible to update; even if you are gone, someone picks up your class, as long as there is a detailed document, you will understand, it is also paving the way for later people. Let's update the upgrade, there is a more meticulous job, your follow-up work is relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively relatively easy. The project ends, then it means that the product will come out. Is the customer care about how to use software? So a detailed operating manual is indispensable. For developers, we must fully take into account customers who do not have professional knowledge. So, the font size is greater than 10 to facilitate people to read; the font should use standard prints. Next, there must be specific requirements for expression methods. For example, sentences must use a single sentence to avoid composite sentences; do not use their own words and self-test; a small section means, how many words in a small festival; Use less passive language; reduce professional terms to minimum; no symptoms, etc. The manual must stand in the customer's position, fully consider the way of easy-to-understand expression, less use "How to" "sentence, do not be used by customers to feel the feeling of order, thus generating the resentment. The specification is also less graphic, the graphics are simple, and the graph is used to explain the use of the product, it is also indispensable. Not only is the image of the function and how the product is explained, but also with a strong emotional tendency, allowing customers to install and use a strong interest. Therefore, the graphic in the specification is puzzled, making text descriptions, allowing consumers more easily to understand the functionality and use of the product. Finally, a good manual can replace the service hotline. With the improvement of the law and the increase in product functions, the current instructions are not moving, and people have forgot to have forgot the front.

转载请注明原文地址:https://www.9cbs.com/read-121475.html

New Post(0)