Why does "software engineering" need to write documents

When I was working on a soft document, I found a few students asked how to write a document, some students are directly up to write their own, some have borrowed from the other people's document template and then to write their own template, these are no problem, all can, after all, this is the first contact with the document.

Just chat with the Master lemon, speaking of documents, I asked her inside the content is not fully reference to the template's answer, she asked me why you want to write documents, I was blindfolded, just want to say the training plan requirements of Bai, to this step Bai, but feel this is definitely not her answer.

She says you first have to understand why you want to write a template, what's in the template, how to draw ...

so I went online to check:

(Official statement)

The developer checks the wrong addendum through the documentation process;

Easy to review, early detection of technical problems;

The next stage of development tasks may be borne by others, output documents to facilitate their work;

Maintenance personnel to carry out maintenance work needs;

Documents are necessary deliverables;

For the desired implementation, usually a responsible person in the head to think about how to achieve, then the mail or phone to find a few related people to discuss even if it is possible, not even a meeting material or meeting minutes.

And foreigners they think that what a person in the mind is not clear and incomplete, and sometimes the idea that the right solution may actually be fatal defects. They demanded that the idea of the mind be documented in order to effectively avoid this problem. In the process of writing documents, you can more effectively, go further to organize your original mind, a lot of problems you can find in the process of writing documents, in addition, the document writing multi-use charts, waste of saliva text as much as possible, and we work with the systems engineer in the system architecture analysis in the drawing of fifty or sixty pictures, Even if he does not understand his written English, from the figure we can clearly guide the entire product system architecture. ”

(Own Phase method)

Writing documents is not just about writing to others, it's about writing to yourself. The process of writing a document is equivalent to a more detailed and tidy up the idea, clear thinking, everything will become clear, there is a "mountain poor water complex suspect no road, Vista" feeling, and suddenly the brain memory of these things transferred to a document, two words, comfortable ~ ...

Also if you are a team leader in a company, with the project at the same time to form a document, in the face of problems, easy to consult the solution, not so messy; even if the project later, someone else take over, directly to him to read the document can be, not so much talk to him, said also may not remember, causing unnecessary trouble, improve efficiency

Finally, even if you are familiar with the process steps, you always have a forgotten day, but the document can be saved for you forever ...