Write your own C # framework from scratch (4) -- document writing instructions

 

When it comes to writing documents, many people are both the first and the second largest. They don't know how to write documents. Most of them can be dragged and dragged, so they can handle it without being dragged,

Why do many programmers resist writing documents?

 

This article mainly aims to tell beginners why we need to write documents, what help does writing documents for our development, and a rough understanding of various documents.

 

Benefit 1: confirm the requirements and reduce the workload of program modification

 

Benefit 2: Help us get familiar with projects

 

Benefit 3: improve development efficiency and prevent errors

It took only one day to complete the main business logic, a 2 k multi-row storage process (including comments, and then constantly add new businesses and finally expand to more than 3 K lines ), it took another half a day to call the program on the mobile phone and the interface on the server, and it took only half a day to complete the test. After several bugs were modified, the system was ready to go online. After going online, I often experience the pressure of several K concurrent jobs. I have been running to the company for transformation. I haven't encountered any problems for more than two years. Why is this complicated logic, but the development takes a short time, after the test is launched, it runs normally under high concurrency pressure? The primary benefit is to make full use of the demand analysis and development documentation at the early stage. If not, everyone who has tried it will know, you know. Many common problems can be solved only by truly understanding the project requirements, streamlining the project process, and in-depth thinking.

　

Benefit 4: control the project progress

Benefit 5: provides guidance for future testing

Benefit 6: support secondary development and software maintenance

 

... (Other help)

In addition to the above benefits, it is the best way for beginners to write a good document and cooperate with the corresponding successful works.

 

You do not need to write standard documents at any time

 

How should I write a beginner's document? What template or format is used?

Note:

What are the topics of different documents?

Reasonable. It also serves as an overall guide for detailed functional design, database design, and other related designs, to understand the basic algorithms needed during the development process and possible problems. It is also convenient to split detailed design and related design tasks and allocate them to different owners for writing, reducing the time required.



To add a new field. After adding the field, you must synchronously update the detailed design document to add the newly added field or function description.

 

 

　　

 

At least there are textual records. However, it is no big deal to let the demand side know how much you have done and how much work you have used, rather than making them feel like they have changed this demand, because most people on the demand side do not know the work and effort you spend on code.

　　

Copyright:

This article was originally published by AllEmpty and published in the blog Park. You are welcome to repost it. You must retain this statement without your consent (otherwise, you will be entitled to pursue accountability) and provide the original article link clearly on the article page, if there is a problem, you can through 1654937@qq.comThank you very much for contacting me.

The content of this article, as long as the main and everyone to learn and make progress together, interested friends can add Q group: 327360708 or e-mail to me (1654937@qq.com), everyone to discuss.

For more information, visit the blog: