SuperAPI AI 工具集

project-documenter

办公与效率

查看项目

更新于 10-16 05:45

技能介绍

用途:为任意软件项目生成生产级文档,构建三层 AI 原生文档层级——/docs/** 子文档承载全部细节,CLAUDE.md 是工程导航图(150–300 行),DOC_INDEX.md 是压缩路由层(约 1–2k tokens)。核心规则:细节只存在于子文档,CLAUDE.md 路由到子文档,DOC_INDEX.md 路由到 CLAUDE.md,层间不重复;后两者最后生成。

主要能力与模式:0 Express(全新项目,一次生成完整包,跳过审计);1 General(README、CONTRIBUTING、API_REFERENCE、MODULES、CHANGELOG、ADR 等);2 AI/LLM(PROMPTS、LLM_ARCHITECTURE、AGENT_WORKFLOWS、MODEL_GUARDRAILS、AI_RUNBOOK、PROMPT_TESTS、LLM_COST_MODEL、AGENT_SAFETY_MODEL);3 Architecture(SYSTEM_OVERVIEW、REPOSITORY_MAP、RUNTIME_FLOWS、DEPENDENCY_MAP、DATA_CONTRACTS);4 Full(三个域加既有文档审计);5 Self-Heal(生成 Cursor .mdc 规则、GitHub Actions CI 与 Python 脚本,做漂移检测、定向更新、完整性校验,需已有 CLAUDE.md 和 DOC_INDEX.md)。

使用方式:按固定顺序执行——INTAKE(选模式、确认既有文档情况)、AUDIT(扫描并分类既有文档,仅 Mode 0 跳过)、REPO SCAN(建立代码库模型)、SUB-DOCS(深度优先生成域文档)、CLAUDE.md、DOC_INDEX.md、REPORT(完成报告并 present_files)。每个子文档需带 Parent/Index/Related/Read when 头部与 Known Gaps 尾部;流程与架构用 Mermaid 图;约束用 RFC 2119 措辞。

限制:Mode 5 需先有 CLAUDE.md 与 DOC_INDEX.md;CI 需在 GitHub Secrets 配置 ANTHROPIC_API_KEY(可选 OPENAI_API_KEY 作为回退),高严重度漂移会以 exit 1 阻止合并;标记 Replace 的文档需用户确认后才覆盖;仅创建代码库实际支持的文件,跳过项在报告中说明原因。具体价格与平台支持暂未提供。