用途:指导撰写面向最终用户(通常非技术读者)的产品使用指南、帮助中心或产品手册,帮助用户用产品完成目标。它承载判断方法,而非章节清单——章节结构由单独的模板工具提供。
主要能力:从上游文档(功能规格、用户流程、线框图等)为每个用户目标推导一个 how-to,避免凭空编造步骤;保持 Diataxis 四种模式(教程、操作指南、概念解释、参考)彼此区分;确保每步与产品实际行为一致并使用精确 UI 标签;用通俗语言写作;保持指南可访问、易查找;在产品变更后修订已发布指南。
使用方式:先通过内容模板工具获取章节结构,再按步骤执行——枚举用户目标(每个目标一个 how-to)、写单一成功路径的入门教程、以祈使句编号步骤写 how-to、写无步骤的解释与完整的产品功能/配置参考、从已知错误状态构建故障排查、用精确标签命名控件并以文字描述界面、使用通俗语言并保证可访问性、设置起始指引并追溯每步来源、修订时做范围界定与陈旧内容清扫并更新版本与变更记录、交付前按质量门槛自检。
适用场景:撰写最终用户/客户可见的使用指南、帮助中心、产品手册;产出完整最终用户文档集(入门教程、任务 how-to、概念解释、功能/配置参考、故障排查/FAQ、术语表);上游变更后修订已发布指南。
限制:不用于评审已完成指南(属 reviewing-user-guide);不用于开发者工具的采用/集成叙述(属 authoring-developer-guide);不用于 HTTP/SDK 端点目录(属 authoring-api-reference);不用于内部工程文档。资料未提供具体安装命令、收费或平台信息。