用途:为项目生成、维护和改进文档,采用“README 作为落地页 + 详细文档按主题拆分到配置的 docs 目录”的结构。
主要能力:README 保持约 80-120 行,只放第一印象、安装、快速示例和详情链接;详细内容写入解析后的 docs 目录(paths.docs,默认 docs/),每个文件自包含、一页一主题;避免重复,README 只链接不重复;每个文档页带 prev/next 导航头和“See Also”相关页链接;支持审计现有文档、把过长 README 拆分、把根目录散落的 Markdown 文件整合进 docs 目录;--web 标志可生成 HTML 版文档。
使用方式:先读取 .ai-factory/config.yaml 解析 paths.description、paths.architecture、paths.docs 及语言设置,不存在则用默认值(.ai-factory/DESCRIPTION.md、.ai-factory/ARCHITECTURE.md、docs/、en);再读取 DESCRIPTION.md、ARCHITECTURE.md,探索代码库(package.json、composer.json、requirements.txt、go.mod、Cargo.toml 等及 src/ 结构),并读取 .ai-factory/skill-context/aif-docs/SKILL.md(若存在则强制遵守,其项目级规则优先于通用规则)。根据状态处理:无 README 时全量生成;有 README 无 docs 目录时提议拆分;两者都有时按标志审计或改进。移动/合并文件前必须展示计划并获用户批准,不强制移动。
适用场景:需要统一项目文档结构、把冗长 README 拆分为主题文档、整合根目录散落 Markdown、审计文档导航与链接、或从现有文档生成 HTML 站点。
限制:资料未提供具体安装命令、收费、价格、平台支持范围及效果数据;部分内容(如 REVIEW-CHECKLISTS.md 的完整合规表)在资料中被截断,暂未提供。