SuperAPI AI 工具集

howto-docs

写作与研究

查看项目

更新于 10-15 21:39

技能介绍

用途:howto-docs 是用于编写 How-To 操作指南的文档写作技能,面向已有一定产品熟悉度、希望完成具体任务的读者,提供任务导向、可执行的步骤化内容模式。

主要能力:给出 How-To 指南模板(标题、简介、Prerequisites、Steps、验证、Troubleshooting、Next steps);标题约定(以 How to 开头、使用主动动词、具体化目标);步骤结构(每步一个动作、以动作动词开头、展示预期结果);用户视角写作;前置条件写法;以及 Steps、CodeGroup、Warning/Note/Tip、Expandable 等组件用法。还提供发布前的硬性门槛与检查清单,并说明何时用 How-To 而非教程、解释或参考文档。

使用方式:依赖 docs-style 技能获取核心写作原则;判断文档类型可参考 docs-style/references/diataxis-compass.md。按模板组织内容,用组件呈现步骤与提示,发布前逐项通过硬性门槛和检查清单。

适用场景:为有明确目标的用户编写操作指南、任务指南、流程说明。

限制:资料未提供安装命令、收费、价格、平台或效果信息;具体命令与代码示例需按实际产品填写。