SuperAPI AI 工具集

readme

写作与研究

查看项目

更新于 10-15 20:35

技能介绍

用途:为项目生成或更新面向 Product Owner 的法语 README.md,并维护 docs/ 技术文档。

主要能力:探索代码库(包清单、目录结构、CI/CD、数据库、路由、Git 记录、环境配置);按固定模板生成 README,含目录、产品价值、主要功能、架构 Mermaid 图、环境表、部署流程、技术栈与文档链接;审查 docs/ 下每个 .md 并按文档质量规则改进;对比代码功能与现有文档,提出缺失文档建议;仅在根目录不存在时生成 CLAUDE.md 和 AGENT.md。

使用方式:作为技能调用,按步骤执行——先探索代码库,再创建或更新 README,随后生成 CLAUDE.md/AGENT.md,审查 docs/,做缺口分析并询问用户是否创建新文档,最后汇报创建与更新清单。

限制:README 与文档正文须为法语,使用 vous;句子不超过 20 词;除 Mermaid 外不放代码块;Mermaid 仅允许 graph、flowchart、sequenceDiagram,节点 8-10 个以内且标签为法语,每图需配文字说明;不删除已有文档,只改进内容;已存在的 CLAUDE.md 与 AGENT.md 不修改;文档描述须来自实际阅读而非编造。

适用场景:项目无 README、README 过时、重大功能或架构变更后、向 Product Owner 或新干系人介绍项目时。