该技能用于为 Inkeep 文档站点(agents-docs 包)撰写或更新文档,围绕面向客户的功能、API、SDK、CLI、UI、配置或行为变更展开。其理念是每个客户可见的表面都需被完整记录,文档是产品的权威来源;代码变更时应同步更新既有文档,准确性优先于速度,术语与结构需保持一致,并按受众调整深度。
工作流包括:先梳理变更涉及的表面(SDK/CLI、Dashboard、API、Widget、自托管等)并查找既有文档;判定文档类型(概述、参考、教程、集成);编写 frontmatter(title 必填,可选 sidebarTitle、description、keywords、icon);按模板组织内容;正确使用组件与代码示例;必要时更新 meta.json 与 redirects.json 处理导航和重定向;最后按检查清单验证。
文档类型对应不同模板:参考型含快速开始、参数表、示例;教程型含前置条件与 <Steps> 步骤;集成型含安装与平台差异 <Tabs>;概述型含关键特性、工作原理与卡片导航。组件方面,多语言用 <Tabs>,顺序步骤用 <Steps>,跳转用 <Cards>,补充内容用 <Accordions>,提示用 <Tip>/<Note>/<Warning>。全局组件还包括 <Image>、<Video>、<CodeGroup>、<Snippet>、<AutoTypeTable>、<SkillRule>、<ComparisonTable> 等,无需导入。
代码示例要求标注语言标签、可直接运行、使用真实占位值,如 apiKey: 'YOUR_API_KEY';表格用于共享属性的参数对比。内部链接使用相对路径并省略 .mdx,外部链接使用描述性文本。写作上要求简洁、主动语态、直接指导、解释原因,避免“simply/just”、避免未声明前置条件的长篇文字。文件组织上,正文放 agents-docs/content/,片段放 _snippets/,媒体放 public/ 下对应目录;重命名或移动需在 redirects.json 添加重定向并更新内部链接。
不适用场景:编写代码注释或内联文档(非 MDX)、纯内部变更、以及更新内部工具文档(如 AGENTS.md、CONTRIBUTING.md 等)。