SuperAPI AI 工具集

help-docs-writer

写作与研究

查看项目

更新于 10-16 06:24

技能介绍

用途:为产品功能创建面向客户的支持文档,把技术实现转化为易读的用户文档,适用于帮助文章、知识库条目、操作指南与支持内容。

主要能力:通过 AskUserQuestion 收集功能名称(必填)、目标受众(必填)、输出格式(markdown 默认或 html)与帮助中心平台(Zendesk、Intercom、Notion、GitBook 或自定义,可选)。随后检索代码库中的功能实现、UI 组件与路由端点,提取功能作用、用户入口、配置项和错误状态;按标题、概述、前置条件、分步说明、技巧、故障排查、相关文章的结构成文。提供功能走查、快速参考、设置/配置指南三类模板。

用法:使用 ripgrep 检索功能文件与组件,例如: rg -l "feature_name" --type-add 'code:*.{rb,js,ts,py,jsx,tsx}' rg -l "FeatureName" src/ app/ rg "feature" config/routes.rb app/controllers/

写作规范:使用第二人称、现在时、主动语态;每步一个动作并以动词开头,步骤后给出预期结果;可点击元素用粗体,用户输入、URL 或技术值用代码格式;用截图占位符标注需截图内容;用引用块标注 Note、Warning、Tip。输出 markdown 使用 ATX 标题、围栏代码块与表格;输出 HTML 使用 article 包裹、h1-h3、ol、table 和 aside(class 为 note、warning、tip),仅保留 CSS 类、剥离内联样式。交付前按质量清单核对标题、概述、前置条件、步骤、术语、故障排查、截图占位符与相关链接。

平台差异:Zendesk 可用 {{snippet}} 与标签、关键词;Intercom 建议每篇不超过 1000 词并使用其提示语法;Notion 用折叠块和目录;GitBook 用 hint 语法与页描述。

限制:不生成实际截图(仅提供占位符),不翻译为其他语言,不制作视频教程,也不撰写 API 文档(此项建议使用 docs-architect)。具体价格、平台支持范围等信息资料未提供。