| name | mc-update-doc |
| description | 修改用户指定的文档,使其内容符合`docs\PROJECT_CONVENTIONS.md`中的要求 |
任务简介
修改用户指定的文档,使其内容符合docs\PROJECT_CONVENTIONS.md中的要求
任务详细流程
先阅读:/docs/PROJECT_CONVENTIONS.md。重点关注其中“README.md 使用指南”部分的要求。
然后充分阅读相关代码文件,确保你理解了它们的功能、结构、模块关系、上下游依赖关系等,以及文档中提到的容易踩的坑。
- 文档瘦身:原则上,单个 README.md 不应该超过300~500行(巨型目录下的除外,因为巨型目录光是目录结构树就很大了)。对于超限的 README.md,按照相关要求进行缩减。对于不允许出现的那些内容,无论文档行数是否超限,都必须要全部删除。
- 文档补全:对于不完整的 README.md,按照相关要求进行补全。但非必要不要超过300~500行的限制。
- 文档修正:文档中可能有过时、错误、误导性的内容,或者不符合规范的内容,需要进行修正。
- 文档详略程度调整:文档可能有些细枝末节过于详细,需要你进行删减;也可能有些重要内容过于简略,需要你进行补充。总之,文档的详略程度需要符合相关要求。
注意:
- 你被要求审查的文档可能没有上述这些问题,这种情况下你直接放行即可,你不一定必须修改文档内容。
- 不要进行git提交、不要执行编译命令。
- 不允许进入计划模式