SuperAPI AI 工具集

write-docs

写作与研究

查看项目

更新于 10-15 22:37

技能介绍

用途:撰写或修订文档页面,使其符合所属内容类型的写作规范。使用前需先加载 gdd-style 技能,其规则适用于每个页面;本技能补充依赖内容类型的规则。

主要能力:

  1. 确定内容类型。写作或修订前先判定页面类型;若页面混合多种类型,应告知作者并建议拆分。四类内容类型及要求:教程(读者通过动手学习,读者为行动者,使用祈使步骤和“你”,单一路径、不提供替代方案);操作指南(读者完成已理解的任务,读者为行动者,使用祈使步骤,每个条件写在其步骤之前);参考(读者查阅事实,行动者为系统,如服务器、API、命令或组件,命名组件,行动者未知或不相关时可用被动语态,“你”仅用于读者提供或控制的内容);解释(读者理解某事为何如此运作,行动者为系统或设计,命名组件或决策,保留原因与权衡)。
  2. 明确行动者。读者行动时用祈使句或“你”,例如把“列被添加”改写为“添加列”;系统行动时命名具体部分,如“服务器拒绝写入”而非“写入被拒绝”;无法判断行动者时保留被动语态,并标记该句交由作者判断。修订时仍适用 gdd-style 的保真检查:把来源已描述的步骤改为读者行动不算新增主张,而命名来源未说明的系统行动者则算。
  3. 完成前检查:页面只有一种内容类型,或已标记混合;每个步骤和每个系统行为都有行动者,或有标记;语态与对应内容类型的要求一致。

限制:资料未提供安装命令、价格、平台支持等具体信息;本技能依赖 gdd-style 技能,需先加载。