The importance of paper documents

Why do I have to say this topic? Because he let me feel disappointed and confused, by the way to vomit groove unhappy, in the end the document in our project occupy how important? Some small companies from the project to research and development to the end of the project, until the beginning of no complete and decent document, this is to let later people to take over the maintenance of the project the most painful thing. Why is that? My personal view is lazy do not want to write, too troublesome, feel is thankless thing or can't write at all. I think the core of the problem is lazy do not want to write, do not want to stand in the company's long-term development of the point of view to consider the problem, only the immediate interests, or do not want to do a strong and big determination, just want to stick to the status quo, I think such a company can only play, will never become a climate.

I really hate to write documents, feel trouble, no need to write, now I slowly realize the importance of writing documents. Of course not to write documents to write files, then lost meaning, so I think there is absolutely no need to write. I don't think small companies need to write documents and focus on coding, which I think is undesirable, and I think that documentation and coding are equally important, even more than the importance of coding. The benefits of writing documents: 1, reduce the importance of project dependencies, will not be due to the flow of personnel to the project can not be normal operation, but also allow the person to take over the project, quick to get started; 2, can improve the writing, language organization ability; 3, traceability, no problem can not be found, to do well-reasoned , the disadvantage of writing documents is time-consuming and laborious, need to spend a lot of force to maintain, of course, from the short term is not really a good thing, but in the long run is necessary, he will be the basis of the whole software development process, there is good retrospective, not a long time to forget what it is to do. So when I put forward to write the document why someone is resisting, I feel incomprehensible, in public in private are all good for everyone, but is resisted, I do not understand why, want to promote the company from the management, technical aspects to a higher level, unfortunately I rely on my personal strength is difficult to do. Am I now in the muddle, or continue to adhere to its own principles, or wait for the move? Today let me have this impulse, because I feel the company with their own ideas some in and out, there is no growth can speak, only the time, that violates my original intention. I just hope that with the development of the company, a total of progress, not stop, stay in place, muddle through the idea. If that's the case, I'm not going to toss it.

So how do you write a clear, rigorous document? A brief summary of the following considerations:

1, to control the document writing format;

2, control the document chapters, paragraph font size and margins;

3, as far as possible in the document layout clearly clear;

4, in the content should be concise, objective statements, not with personal feelings of color;

5, as far as possible in writing documents do not appear modal words, that appears very not rigorous;

6, write the contents of the first outline, sorting out the approximate ideas and so on.

The importance of paper documents