Some thoughts on technical documentation

Many technicians in the IT industry are not very focused on technical documentation, or are not aware of the importance of technical documentation.

Most people feel that document writing, collation, collation is a very troublesome thing, so many times in order to avoid trouble to avoid and far, in the work on the document, can save the province, can briefly briefly. Many programmers do not write the program when there is no comment, many programmer, including the electronic engineer, in writing the program is not the important variables in the program, when writing the function of the function is not described, there are no parameters, return parameters, as well as the description of the middle important variables.

A period of time in the study of ZigBee, saw others ti company z-stack protocol stack Code, feel that code is an art, looks very beautiful, very artistic sense. Basically every function is a large number of instructions, parameters in the function, variables and return parameters are described in detail, read the description of the function to know the function of functions, at a glance.

I admit that I also have a lot of such shortcomings, but I am slowly improving, I hope to overcome such shortcomings in the future.

I've been helping my teacher write that patent application for a while, feeling that the document is really important. Other people know a project is also through the project related to the document read and learned that the document writing or collation is not good, people do not understand the appearance of the ambiguous feeling, the number of times will be bored, others do not want to cooperate with you. In writing programs, especially when the code of the program is large, a person is basically unable to complete, it is necessary to find someone to cooperate, the final program when the joint adjustment, the process of not understanding other people's procedures or need their own more time to explain, and ultimately not worth the candle.

The Challenge Cup has a period of time, originally wanted to do the real thing, as for the document finishing only a few days to fix. But later found a lot of things not quite, many people asked the descriptive text is very short, a lot of places need to find information, see references, so then originally intended to take 3 days to fix things, the results dragged one weeks, but also often put the time for lunch, evening also busy to 11 points. The results of the report last week when the people were sick, home for two days, or not worth the candle. So in the future, we should pay more attention to document collation.

In this with everyone to encourage, in the work of the document to make unremitting efforts to do better!

Some thoughts on technical documentation