为代码库编写文档
功能说明¶
助手读取一个源代码文件夹,并在每个目录中写入一个 README.md 文件。每个文件描述该目录中代码所提供的功能、遵循的规则及其副作用。父目录会对它下面的各个子目录进行汇总。
何时使用¶
在对现有软件进行设计工作之前,使用 Document a codebase。助手和审查者随后会以代码的书面描述为起点。
你将获得¶
新增或更新的 README.md 文件。若要保持现有文件不变,请要求使用其他文件名,例如 EGM.md。
示例¶
完整说明¶
助手遵循存储库中的 Document a codebase 技能说明。
本页原文 Markdown:在 AtomGit 查看·内容源自开源项目 el/elephant-goldfish-model