SuperAPI AI 工具集

loom-technical-writing

写作与研究

查看项目

更新于 10-15 20:28

技能介绍

用途:为软件项目撰写专业技术文档,包括 README、用户指南、教程、迁移指南、变更日志和 API 文档等。该技能负责“如何写好”,而各文档类型的具体结构由 loom-documentation 负责。写作前必须先阅读代码,不得凭假设撰写。

主要能力:以 Diátaxis 框架为核心,要求每篇文档只服务一种用户需求——教程(学习/获取)、操作指南(达成目标/应用)、参考(查阅/信息)、解释(理解/为什么)。操作指南按目标命名,教程须在干净机器上端到端成功,参考须镜像代码结构并保持完整,解释类文档论证“为什么”。同时覆盖受众区分(开发者、终端用户、运维、新贡献者)、行文风格(主动语态、祈使句、现在时、前置重点、具体不模糊、极简、术语一致)、文档即代码(与代码同仓库同 PR、CI 中 lint 与链接检查、测试代码示例、随代码版本化、尽量自动生成参考)、错误信息写法(发生了什么→为什么→怎么办)、发布说明与变更日志的区别,以及迁移指南结构(概述→前后对比→编号步骤→弃用时间线)。

使用方式:作为技能加载后,按上述规则撰写和审校文档;完成前需核对清单:单一 Diátaxis 模式、语态时态正确、重点前置、术语一致、示例可运行、内部链接有效、结构符合 loom-documentation。

适用场景:软件项目的各类技术文档写作与评审。

限制:资料未提供具体安装命令、收费方式、支持平台或与其他工具的集成细节,暂未提供。