Why programmers don't want to write documents _ documents

Source: Internet
Author: User
Tags documentation
When it comes to documents, someone will talk a lot about foreign companies, large companies, formal companies how to attach importance to the document, what 2/3 time for writing documents, 1/3 time to be used for programming; what ISO, what CMM, and what standards to write a document according to? It's not a document, it's not a good document. , do not pay attention to the document is not formal and so on. When asked what documents he had written and what document standards he had written, such people were speechless.

In any case, the document is definitely the biggest weakness of programmers. Some programmers, known as masters, may be a document imbecile. Whether the programmer is in a large company or a small company, whether the programmer is writing a document or not writing a document, most programmers are deeply reluctant to write a document.

Programmers are generally reluctant to write documents, but programmers like to read other people's documents. Even if you write a document, programmers typically don't write all of the features into a document, but complain that there are features in other people's documents that are not described. Even if you are willing to write a document, programmers generally do not write the document in detail, but complain that other people write a document is not detailed. The document is definitely a contradiction in front of programmers, and if programmers choose to prefer to write documents or read documents, I reckon most programmers will choose the latter.

So why aren't programmers willing to write documents? There are many reasons for this, and I have summed up several points myself:

1. Fear of annoyance
Programmers from the beginning of the day, buried in the heart of a programming seed, think that programmers are programmed, and computer dealing with, the program is the whole programmer. Whether you're writing a document before you program, or writing a document after programming. They all think that writing documents is annoying.
1 There are too many types of documents. The more formal the more. The idea of writing so many documents made the programmer's head big.
2 Document writing requirements are not low. Format requirements, content requirements, but also need to draw a variety of flowchart, schematic, diagram, interface map and fill in various forms, and to collect a variety of information. Although there is no technical content, but it will take more time than the program, and not necessarily write well.
3 in a formal development company A general change is to write a series of change documents. When constantly changing, only the final change document is the most important. When we don't know if this is the last document, we don't want to write a document that might be replaced by a later document.
4 when the document is written, there will always be people using the document to ask for details, and these inquiries tend to crash. This is because it's hard to write a document that keeps everyone out of the question.

2. Not available
In many cases, programmers are in a "time tight, task heavy" state. In the rush to get programming results driven by the programmer is obsessed with programming, want a minute a change, which has the mind and time to write the document before programming it. Even if they have the idea of making the program first and then filling it out, once they have completed a program, they immediately jump to the second. So, writing documents can only be put in the late stages of project development. If you really write a document, the time to write the document has already been the programming time to squeeze, your programming work will not be finished.

3. No use
The importance of documents is not the same for different objects. If you say the document is useless, someone will immediately drown you with spittle, and they will immediately move out which one to say the document is important and the document is indispensable. I am afraid to say "I think the document is important". This, in turn, shows that the usefulness of the document is not the same for different people. For programmers, as long as the program can be compiled. Many programmers write out programs without writing documents, and in their minds the documents are not written. If the document is programmed, make sure that the document is correct and not modified. In fact, documents are not as fast as programming, and programming is not as fast as changing, and changing requirements and code make documents as obsolete as paper.
In reality, some documents become the summary after the development of the project, not to the development itself, but to retain a form of existence to meet the needs of a variety of norms. In this case, the document has no practical value, so it doesn't work even if the programmer writes it. In particular, after the project put into production, after several upgrades, the original document already and the reality of the situation is not on the number, document updates and system consistency is difficult to control.

4. No good.
Since it is thought that coding is the right way, then programmers write documents is an additional and ancillary work, do it, for programmers no good.
Of course, the benefits of documentation are more embodied in software companies, organizations, software users, and subsequent programmers, which is a "Masarica, Horong" good thing. So programmers don't want to write documents.
How important the document is. Someone put it up to the "copy of the Programmer's mind," some people even say that after the programmer has gone, as long as the document, software companies can recruit new people, the company still running. So, clever programmers will write the documents clearly.

5. Do not write
It is not easy to write a document from the point of view of writing itself. The document has a document format and writing requirements. Now people just like to say things, not many people in peacetime will write pen, let alone write articles. Therefore, it is theoretically necessary to write a document to learn and train, the need for writing in peacetime accumulation. When a programmer is asked to write a document, he will often answer you: "How to write." I won't. "You can't write can not blame you, you do not go to learn, but confidently say no, it is your fault." Are the people who write the documents "nerds"? Don't they know the truth about working hard?
When a man to a favorite woman to show love, need to use a love letter to vindicate, he can not write love letters. Even if he can not write, he will certainly overcome hardships to write out the feelings, this is his subjective dictates. If a programmer wants to write a document subjectively, how can he be afraid of annoyance. How can I be afraid of not being available? How can you be afraid that the document is useless. How can I be afraid of not writing. These fears are actually excuses. A really good programmer should be not only a master of programming, but also a master of writing documents.
The reason programmers really don't like to write documents is that they are for others to read, not for themselves. If programmers like to write documents, it is necessary to improve the programmer's awareness and realm, or to the programmer to write documents to reward. But rely on the system, the management lets the programmer write the document to be only one kind of professional malpractice. When one day the document is also a professional job, programmers and documents are separated, the programmer will be focused on the document to write code, the document will be used as a career, dedicated to writing documents to get wages. We will no longer discuss this. This division of labor must be the future trend. Some big companies or regulated companies already have such a division of labor. Just a lot of small and medium-sized software companies or enterprises in the IT department has not been professional to such a degree. Programmers do not like to write documents may indicate that they are unwilling to take on too many roles.

Anyway, as a programmer (especially want to become a good programmer) must learn to write documents, must learn to appreciate the document. Whether you like it or not, you should be able to get back in front of all the documentation issues. It can be said that programmers who neither write documents nor appreciate documents are not qualified to say "I don't like to write documents".

Contact Us

The content source of this page is from Internet, which doesn't represent Alibaba Cloud's opinion; products and services mentioned on that page don't have any relationship with Alibaba Cloud. If the content of the page makes you feel confusing, please write us an email, we will handle the problem within 5 days after receiving your email.

If you find any instances of plagiarism from the community, please send an email to: info-contact@alibabacloud.com and provide relevant evidence. A staff member will contact you within 5 working days.

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.