Seventh Zhou-Talk about various documents

Source: Internet
Author: User

  By the end of this week, our project team had written the prospectus, the requirement Analysis specification, the outline design specification, the detailed design specification, but after the teacher gave the template, found that we wrote the document and the teacher gave the template still has a very big gap. So part of this week's work is to change the documentation. Although the format or template of various documents is not immutable, but in the teacher's request will be our documents more rigorous than before, the ability to write documents has been improved.

Software Process , the document is already part of the product. Moreover, documentation is often used as a milestone marker, making it possible to track and control the project, and to make every part of the software production traceable to ensure the quality of the software. That's why our group treats every document we write. As the teacher in the class when referring to the drawing of the flowchart, the basic of our previous painting is wrong, so for each time there is a picture of the part, we will carefully find the information and then start painting, to ensure the speed of the quality must be guaranteed at the same time. In this way, just by writing a document, we can also consolidate the knowledge we have learned.

for a variety of documents, according to my online understanding, software developers do not want to write documents, I think this mainly refers to the staff who have just participated in the work for a long time. The general reason should be:

(1) the big environment for software development is not good. (2) The study of heavy skill, and the cultivation of contempt ability, our country's software developers pay attention to learning skills. (3) pay attention to the surface of things, despise the foundation, speaking of the basis of such as: data flow chart, database design in the 1nf,2nf,3nf,bcnf. (4) The does not understand the system, is the most important reason to write bad documents. does not speak the hierarchy of problems, the complexity of the problem is unclear, is a developer does not write the document another reason. Poor writing skills are a reason for not writing documents. We are learning science and technology, writing skills almost no relationship, this is a lot of software personnel's argument. (7) The last reason, This is a really embarrassing reality, a lot of people have not done formal development, not even seen the real ' Good ' technical documentation, naturally can't feel the role of good documents, so now that this bad document is the best, and these documents for development does not have any effect (instead of time), naturally do not want to write a document.

Seventh Zhou-Talk about various 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.