SuperAPI AI 工具集

doc-smith-create

写作与研究

查看项目

更新于 10-15 20:24

技能介绍

用途:从工作区数据源生成和更新结构化文档,所有输出创建在 .aigne/doc-smith/ workspace 中,支持首次生成完整流程与用自然语言修改已有文档。

主要能力:workspace 初始化与 git 管理;基于项目 README 和目录结构推断用户意图;规划 document-structure.yaml 文档结构;并行按文档分发内容生成任务;媒体资源扫描与图片生成;HTML 构建、结构/内容校验、自动提交。修改已有文档时不需要 changeset/PATCH 机制。

必要用法:workspace 必须先初始化,例如 mkdir -p .aigne/doc-smith/{intent,planning,docs,assets,cache}、cd .aigne/doc-smith && git init 并创建 config.yaml。结构确认后生成导航:node skills/doc-smith-build/scripts/build.mjs --nav --workspace .aigne/doc-smith --output .aigne/doc-smith/dist。内容生成 Task 须使用 run_in_background: true,每篇文档一个 Task,≤5 篇并行、>5 篇分批;通过 .aigne/doc-smith/cache/task-status/{slug}.status 轮询结果。图片后端检测需在前台完成,结果取值 gemini-sdk、afs-cli 或 skip,只有用户明确选择跳过才可设为 skip。完成校验:/doc-smith-check --structure 与 /doc-smith-check --content,通过后自动 git commit。

适用场景:为项目生成结构化技术文档、更新既有文档结构、需要统一 workspace、导航构建与 HTML 输出的文档工作流。

限制:locale 初始化时若用户未指定,必须用 AskUserQuestion 确认,不得默认写入;结构变更后须校验并重建 nav.js;docs/ 目录不得残留 .md 文件;所有内部链接用文档 path 格式,资源引用用 /assets/xxx 格式;单批等待上限 10 分钟;后台 Task 不应读取 output_file。其他细节暂未提供。