test.md

如何去写项目的文档

1.从README入手

1. 简介
   1. 简介里会大致的介绍如何使用，可以从简介里去了解与之有关的知识学习，大致了解代码的大致用途，比如服务对象，提供什么功能
2. 如何使用
   1. 在这里面会告诉如何去运行程序，推荐先去了解一下docker，docker-compose。会提供基本的一些代码配置参考
   2. 详细的代码环境配置与要求可以参考代码中的其他文档，如：dockerfile，docker-compose.yml，需要更改环境配置都在其中进行更改
3. 配置 1.
4. 帮助 1.

2.代码结构

1. 基于ＲＥＡＤＭＥ的大致了解后，大致通看代码，将整个项目的大致结构理出，了解基本的运行流程
2. 可以将了解的过程中遇到的问题进行记录总结，记录解决方法
3. 在大致的结构清晰之后，将模块进行细分理解，这一阶段需要对代码进行仔细阅读理解，要对代码的调用，构造，有一个很清晰的了解。对于涉及的知识要了解清楚，并进行及时的一个总结

题外话

1. 对于一个项目要有一个大致的周期规划，在划分每周的规划进行迭代
2. 每两周到三周进行一个迭代更新，并制定相应的计划完成下一步的要求
3. 基础知识一定要牢固完善

待更新...