SuperAPI AI 工具集

oss-docs

通用与其它

查看项目

更新于 10-15 17:29

技能介绍

用途:为开源项目准备发布所需的文档,审计现有文档完整性、脚手架缺失的标准文件,并按项目类型生成内容。

主要能力:提供 audit(检查哪些 OSS 文档存在或缺失)、scaffold(创建全部缺失的标准文件)、scaffold [file](创建指定文件)、update(用最新模式刷新现有文档)、validate(检查文档是否符合最佳实践)。文档分三层:核心(LICENSE、README.md、CONTRIBUTING.md、CODE_OF_CONDUCT.md)、标准(SECURITY.md、CHANGELOG.md、AGENTS.md、Issue/PR 模板)、增强(QUICKSTART、ARCHITECTURE、CLI_REFERENCE、CONFIG、examples)。

使用方式:先做项目检测,依据 go.mod、pyproject.toml/setup.py、package.json、Cargo.toml 判断语言,依据 Dockerfile+cmd、config/crd、Chart.yaml 判断项目类型(cli、operator、helm、library 等),再按类型选择模板重点。

适用场景:开源发布前的文档就绪审计、补齐缺失标准文件、刷新过时文档、校验文档质量。

限制:不会在未确认时覆盖已有内容;不生成代码文档(应使用 $doc);不创建 CI/CD 文件。若项目信号过少,生成内容可能偏通用,需补充具体仓库上下文。具体安装与调用命令资料未提供。