karrot0195/agent-skills-

gen-docs

当用户要求扫描项目并更新文档（如 README.md）时使用此技能。

步骤

1. 列出项目根目录，识别包、二进制文件、资源文件和配置文件。
2. 读取 go.mod 以获取模块名称、Go 版本和依赖项。
3. 读取每个包中的关键源文件，总结 API 和行为。
4. 更新或创建 README.md，包含：
   • 项目标题和一行概述
   • 目录结构（树形或列表）
   • 包描述，包含关键函数/类型
   • 二进制/CLI 描述
   • 依赖和运行要求
5. 确认文件路径，询问是否需要更多细节（如示例、用法）。

何时使用

• 用户说“更新关于项目概览的 readme”
• 用户要求“扫描项目并更新文档”
• 用户希望根据源代码生成项目级文档