SuperAPI AI 工具集

docs

写作与研究

查看项目

更新于 10-16 05:05

技能介绍

用途:该技能用于为代码仓库生成或更新面向 Product Owner(产品负责人)的法语 README.md,并审查、改进 docs/ 目录下的技术文档。适用时机包括:项目根目录没有 README.md;重大变更后 README.md 过时;新增重要功能或架构调整后;需要向产品负责人或新干系人介绍项目时。

主要能力:

  1. 探索代码库,理解项目目的、架构与技术栈。检查内容涵盖包清单(package.json、composer.json、pyproject.toml、Cargo.toml 等)、项目结构、docs/ 文档、CI/CD 配置、数据库迁移与 schema、路由与控制器、Git 信息、环境配置。
  2. 创建或更新 README.md:不存在则按模板新建,已存在则更新事实性章节并保留团队自定义章节。模板包含项目名、目录、产品用途、主要功能、工作原理、环境、部署、技术栈、补充文档等部分,并附 Mermaid 图。
  3. 生成 CLAUDE.md 与 AGENT.md:仅当根目录不存在这两个文件时才生成,内容包括项目概览、技术栈、目录结构、常用命令、代码约定、Git 工作流、注意事项等。
  4. 审查 docs/ 中的每个 .md 文件:按文档质量规则评估并直接修改,不删除原文件,仅改进内容,并向用户报告每个文件的修改摘要。
  5. 识别缺失文档:对比代码库功能与现有文档,列出缺口,提出新文档文件名、描述与优先级(Critique 或 Important),征求用户确认后按质量规则生成。

使用方式:该技能以分步流程执行,从探索代码库开始,依次完成 README 创建或更新、CLAUDE.md/AGENT.md 生成、技术文档审查、缺口分析与确认。文档统一用法语撰写,使用 vouvoiement,句子不超过 20 词,优先使用要点列表,首个缩略语出现时给出解释。Mermaid 图仅允许 graph、flowchart、sequenceDiagram,节点标签用法语,每个图最多 8–10 个节点,图下须有文字说明。

限制:README.md 中除 Mermaid 外不允许代码块;mermaid 图禁止使用 classDiagram、erDiagram、stateDiagram;CLAUDE.md 与 AGENT.md 仅在不存在时生成,已存在则不改动;技术文档只改进不删除;无法确定的信息保留占位符。