[practical skills] how to write agile development documents

Catalog

1 Strategically attach importance to ： Understand the purpose of writing the document

2 Learning content of technical document writing

3 Key points and difficulties in writing documents

4 PPT Content reference

5 The resources

---

picture source ：https://medium.com/@Cubix.Worldwide/role-of-documentation-and-software-architecture-in-cubix-6c45f1a9657c

At work and github After reading a lot of inappropriate technical documents ,2020 year , I have prepared a technical document writing course for college students and engineers , And shared slides , Download here   Agile development document writing course .pdf- Professional guidance document resources -CSDN download .

Hope to pass this course , Can help you achieve the following goals ：

• Master the basic process and method of writing agile development project documents ;

• Master the basic content of writing agile development project documents ;

• Exercise acquisition 、 Scientific and engineering practical ability to evaluate and communicate information .

1 Strategically attach importance to ： Understand the purpose of writing the document

Writing a document is not nothing , Not to record meaningless content . In the intense agile development process , How to minimize the documentation of agile development ？ We need to understand from the following aspects .

• Why and what are agile development project documents

• How to write and decompose user stories

• How to write good design documents

• How to write good code release and system maintenance documents

2 Learning content of technical document writing

• Explain why you need to document agile development projects .
• Introduce the structure of writing agile development project documents . put questions to ： Recall the process of software engineering and the process of agile development .
• Introduce the overall quality standard of the evaluation document ： accuracy 、 integrity 、 Clarity .
• Introduce the concept of user stories . Examples of user stories . Introduce the logical methods and precautions for writing user stories . Introduce how to evaluate the quality of user stories .
• Introduce the contents of the design document ： Including architectural design drawings 、API file 、 Database design diagram .
• This paper introduces how to evaluate the quality of design documents .
• Introduce the contents of relevant documents for code release and maintenance , Exhibition github Poor quality documentation on , Introduce the structure of relevant documents in detail .
• Describes how to evaluate the relevant documents for code release and maintenance .

3 Key points and difficulties in writing documents

Write qualified documents , The following key points and difficulties need to be solved ：

• The structure and function of agile development project documents ;

• The writing method and content of agile development project documents ;

• Criteria for evaluating document quality .

4 PPT Content reference

I prepared 59 The content of the page , Let's share some videos .

5 The resources

• User story estimation techniques   User story estimation techniques _ agile _Jay Fields_InfoQ Selected articles
• How to segment user stories   How to segment user stories _ agile _Dan Puckett_InfoQ Selected articles
• Internet of things big data open platform   https://github.com/taosdata/TDengine/
• Document reference links Free Agile project management templates and resources - David Hodder
• Templates Scrum Documentation Template | Info-Tech Research Group

I hope you are engaged in computer related work , It can not only leave valuable works , Can also leave technical documents that inspire and guide others .

If you are writing technical documents , Have a question , Please leave a message and communicate with me .