SuperAPI AI 工具集

dify-docs-write

编程与开发

查看项目

更新于 10-15 23:48

技能介绍

用途:这是 Dify 文档仓库中撰写或修订任何文档的入口技能,适用于用户指南、部署页面、插件开发页面、API 规范、环境变量参考和 CLI 文档。目标是交付读者可直接使用的页面:与已发布产品一致,面向读者到达时的场景,用尽量少的文字保持清晰。

主要能力:按目标路径选择规则包(最具体匹配优先),如 en/self-host/deploy/configuration/environments.mdx 对应 dify-docs-env-vars,en/{cloud,self-host}/use-dify/、en/self-host/deploy/、en/develop-plugin/ 对应 dify-docs-guides,{en,zh,ja}/api-reference/ 对应 dify-docs-api-reference,en/cli/ 对应 dify-cli-docs;无匹配路径则由写作指南单独约束。流程分阶段:路由、写作前理解(S1–S3)、确认范围(S4)、撰写(S5)、翻译(S6)、检查(S7)、收尾(S8)。

使用方式:先固定代码引用并逐条核实声明,现有文档不作为证据;无法确认的行为标记为未验证且不写入页面。研究结果按指定格式记录,做读者任务分析。撰写前报告页面与改动、研究摘要、未验证声明和转交问题并等待批准(单页更正或已批准发布同步报告可跳过)。撰写时参考风格指南、参考页与规则包页面结构;研究与撰写由不同会话完成。英文改动需同批交付 zh/ 与 ja/,新页面在同一 PR 注册到 docs.json 三个导航区。检查阶段依次运行 dify-docs-format-check、dify-docs-terminology-check、规则包验证器,最后运行 dify-docs-reader-test。

限制:不确定内容应省略并记录,不得含糊表述;概念页描述、任务页指导;frontmatter 描述最后写。跳过或更改阶段需说明原因。具体命令、参数与更多细节资料中暂未提供。