SuperAPI AI 工具集

documentation-writer

写作与研究

查看项目

更新于 10-15 18:31

技能介绍

用途

documentation-writer 是一个技术写作技能,面向软件文档的创作。它的核心目标是产出高质量的软件文档,并以 Diátaxis 框架(https://diataxis.fr/)的原则和结构作为严格指导。

主要能力

该技能围绕 Diátaxis 的四个象限组织文档类型,并明确区分各自的目的:

  • 教程(Tutorials):以学习为导向,用实践步骤引导新手达成成功结果,定位为一堂课。
  • 操作指南(How-to Guides):以问题为导向,提供解决特定问题的步骤,定位为一份食谱。
  • 参考(Reference):以信息为导向,对机制进行技术性描述,定位为一本字典。
  • 解释(Explanation):以理解为导向,阐明某一特定主题,定位为一次讨论。

其遵循的指导原则包括:清晰(使用简单、清晰、无歧义的语言)、准确(确保所有信息,尤其是代码片段和技术细节正确且最新)、以用户为中心(始终优先考虑用户目标)、一致性(在所有文档中保持统一的语气、术语和风格)。

使用方式

技能规定了固定的工作流程:

  1. 确认与澄清:确认请求,并提出澄清问题以补全信息缺口。在继续之前,必须确定文档类型、目标读者、用户目标与范围(包含什么、排除什么)。
  2. 提出结构:基于澄清后的信息,提出详细大纲(例如附有简要说明的目录),并等待批准后再撰写完整内容。
  3. 生成内容:在大纲获批后,以格式良好的 Markdown 撰写完整文档,并遵守全部指导原则。

在上下文感知方面,当用户提供其他 Markdown 文件时,技能会将其作为上下文,用于理解项目现有的语气、风格和术语;除非用户明确要求,否则不会复制其中的内容。此外,除非用户提供链接并指示,否则不会查阅外部网站或其他来源。

适用场景

适用于需要按 Diátaxis 体系组织软件文档的写作任务,例如为新用户编写教程、为特定问题编写操作指南、为机制编写参考说明,或为某一主题编写解释性内容。

限制

该技能不会主动查阅外部网站或其他来源,除非用户提供链接并明确指示。它不会复制用户提供的其他 Markdown 文件中的内容,除非用户明确要求。关于收费、价格、平台或具体集成方式等信息,资料中暂未提供。