SuperAPI AI 工具集

ai-factory.docs

写作与研究

查看项目

更新于 10-16 06:23

技能介绍

用途:为项目生成、维护和改进文档,采用 README 作为落地页、详细内容放入 docs/ 目录的结构。

主要能力:README 保持约 80-120 行,只放简介、安装、快速示例和文档链接;每个 docs/ 文件自包含、一页一主题,避免重复;文档页带 prev/next 导航头和 See Also 尾节,链接使用相对路径;内容以表格、列表、代码块为主,便于扫读。

工作流程:先读取 .ai-factory/DESCRIPTION.md 并扫描代码库与根目录散落的 Markdown 文件;再判断状态——无 README 时全量生成,有 README 无 docs/ 时提议拆分,两者都有时审计改进。审计会检查 README 长度、缺失主题、过期内容、导航、断链、格式一致性和标准符合度,并给出修复方案。散落文件(如 CONTRIBUTING.md、ARCHITECTURE.md、API.md 等)可提议移动或合并到 docs/,但不会强制移动,需用户确认;CHANGELOG.md、LICENSE、CODE_OF_CONDUCT.md 保留在根目录。

使用方式:通过 --web 参数可生成静态 HTML 站点,输出到 docs-html/ 目录,命令为 mkdir -p docs-html。

适用场景:需要规范项目文档结构、拆分过长 README、整理散落文档或生成文档站点的项目。

限制:具体安装命令、收费与价格、支持平台、效果数据等资料暂未提供;文档生成与改动需用户确认后执行。