SuperAPI AI 工具集

tech-doc

写作与研究

查看项目

更新于 10-15 20:21

技能介绍

用途:面向技术协作场景,提供撰写与维护高质量技术文档的统一写作规范,适用于介绍/解释型文档与速查/SOP类文档。

主要能力: 写作基线要求先结论后解释,采用金字塔结构,层级不超过三层;事实准确优先,不脑补、不扩展原始信息,术语统一可追溯;短句主动语态,数值带单位,Markdown 标题不超过 4 级,命令与路径用反引号标注;首段交代目标、读者画像、前置知识与范围外内容。 介绍/解释型文档用单段说明 What/Why/Outcome,再列 2–5 条支撑要点,展开覆盖流程、边界与典型反例,新概念先给直观例子再补正式定义。 速查/SOP 文档以一句话描述任务与预期,随后用 1–3 行说明适用范围、前置条件、风险或权限,立即给最短可用示例;采用“索引 → 分类 → 卡片”结构,卡片为“名称/意图 → 最短示例 → 常用参数 → 常见错误 → 相关资料”,不凭空新增步骤,补充内容标注“待确认/建议补充”。代码块标注 bash/sh,无提示符,提供占位符说明,优先给 --dry-run 或只读版本。 信息边界:不添加原文未给出的结论或数据,修改错别字或数值前需确认并记录原因;关键定义、API、协议引用权威来源并注明链接、版本与访问日期,冲突时列出差异与采信理由;保持命令、代码、图表语义不变。 排版:标题与列表控制在 2 层,长段落拆为列表或表格,对比用表格或并列小节;内联代码只包裹标识符或命令,标点写在反引号外;代码块按步骤分块并说明执行权限;链接锚点可读稳定,外链注明版本或提交号与访问日期,图片需替代文本。 协作提示:信息不足或上下文不清时应先与开发者/作者确认再扩展发布;发现冲突或风险先提醒并同步讨论记录,便于后续维护追踪。

限制:具体安装、配置与使用命令暂未提供。