Naked, I want to say that you are not easy.
It is a very sensitive word. In the traditional country in China, if someone is bare in the street, waiting for him, I am afraid it is a policeman and doctor. But what I said today is not the naked row you think. I refer to a "bake" phenomenon in project or product development. Any company will encounter this situation in any more or less: A product began to horses before do not have a complete feasibility analysis or demand analysis, and a project is not described in any document (or very little document). Lower, and even related development schedules are also thinking about it in the case of course. As such, we call it "bare". At this point, in addition to the product or project outline in the brain, there is only a large number of source code. That is to say, in addition to the code, there is no leaving, there is no system architecture and design, no business execution process. Such a system, do not change people, no problem, once the program is problem, it is buddy, and the code you pick up the hand is probably the cut, and it is still chaos. Especially the code for maintenance, I am afraid you get more and more you don't understand. Such project maintenance is quite troublesome.
Projects without documents are a disaster.
People who have done the technology know that the most painful is to see someone else's code, especially if there is no document, there is no process describing and design ideas. I would rather write another time I don't want to maintain other people's "naked code". . People who don't say to these codes are like a few years ago, you have the same rookie, and you don't say that your code is written. The coupling between your modules is low enough. Does your code use an object-oriented? The encapsulation, but because the code itself is not a good way to express system structure and design ideas. Especially when a system has been revised by several people, it will become a big thing. Everyone will modify according to their own way, add new features in accordance with their own understanding, solve the old problem, and may introduce more new bugs, resulting in the constant system, but the stability is constantly decline, and finally. Like Microsoft's operating system, the more patch, the worse the stability, and finally simply dead, let you hate it, love is not. With proper documentation, it can be well described with the system structure and the function of each module, and the basis for the system is designed to ensure that the place is found to increase the modification code. Do not affect the other The function of the module is as much as possible to limit the error within a small module, which is not affected to the overall situation. The development documentation can be said to be a user instruction manual in the face of our developers, and its developers have basis for modifying and maintenance. For teams, writing and maintaining a document with a system structure is necessary. In the actual situation, once the code is written, it will enter the maintenance phase. The number of times the code is modified is far more than the number of times the number being written. Therefore, we need to pay more attention to the classics and easy modification. As long as the project is still in the life cycle, the system is still in use, then this maintenance and modification will never end, and the guidance of the document still exists.
Go together to bake.
According to what I said, is it what we can't "bare"? For example, a certain night, the earthquake suddenly came, you are a first slow-hearted clothes from calmly dressing to safety places in an elegant gesture? Still bare running? The answer is of course obvious: first naked, and then say, "life is precious"! At this time, when there is a market, if there is a hidden, this is the most critical thing to take the first blank market, who will go to the software engineering method to complete a large pile of cumbersome documents in advance. ? When you have developed a new product in your cattle, I am afraid that the market will be divided by others, and it is the remaining meal. For people, life is important; for the company, the market is the first. A small item, no document is also possible. If the code amount is less than the amount of documents written, there is no documentation that is not necessary to write. If the processing of the business is in line with the industry standard, there is of course no documentation. If the code is written very well, it is a self-comment or more detailed, the document is excessive. But when a project has a certain size, as the system is getting more and more huge, the functions are getting more and more, the complexity of the system is getting higher and higher, and there is a better code to write more detailed notes. System, this time the system document should be paid attention to this time. So, when it is bare to the safe zone, we should reassure the clothes, don't produce "nude code". Besides, even when it is the most critical time, I have to find a little thing to block some important part, can't stand naked. For example, there is always a system architecture map in the project, which is an important document such as an explicit interface specification manual. Even if it is not a special specification, there should be a draft document. The appropriate document is always needed. If you don't even have these, it is really a bare rush. A little idea.
The importance of documents in developers is equivalent to customer information in market personnel, which are them to keep working properly and improve work efficiency. Many companies have such provisions: Each market personnel need to submit a hand customer regularly to the company. For market staff who are about to leave, you must submit complete customer information to the company; each technician works a paragraph, and it needs to be The work of the hand is organized as a document for later people. The reason and benefits of this are obvious. People can go, the resources can't take away.
Documentation can be said to be a precipitate of company culture. Developing documents is a accumulation of company technology. It is not only the guidance of the developer, but also the reference and good information of the technician. There is no too much document, and it can't. Too many documents are also a disaster. To write so many documents, it is not easy to maintain all documents synchronous to keep content. There is no one in the world, no matter how things can be taken, it's okay, these will see how you grasp. So, I want to experience the sprinkle and avant-garde, and I want to be unrelegant of traditional morality, this requires a compromise method to find a balance point. And this balance is not easy to find, just look at you is a wisdom.
