SuperAPI AI 工具集

technical-documentation

写作与研究

查看项目

更新于 10-15 21:34

技能介绍

用途:为软件开发者撰写、改写、组织或审校技术文档,覆盖 README、教程、操作指南、概念、参考、排障指南与发布说明等类型。

主要能力:先建立文档契约,明确受众、读者目标、文档类型、版本、前置条件、范围与排除项;写作前查看源码、API 结构、命令、测试、界面与现有文档,优先可验证的一手来源。不得编造命令、参数、端点、配置项、默认值、限制、权限、兼容性、输出、错误信息、副作用、版本支持或安全承诺;无法核实时标注为假设或省略。

使用方式:按读者需求选择结构。任务类文档先给结果,列出前置条件,按操作顺序写步骤,说明如何验证成功;概念与参考类文档围绕读者问题组织。默认用对话式、直接语气,称读者为“you”,指令用祈使句,优先主动语态与现在时,句子尽量少于 26 词。标题用句式大小写,任务标题以动词开头。代码示例需先说明用途,块需标注语言标识,占位符用大写蛇形命名如 PROJECT_ID。

适用场景:README、入门教程、单一目标操作指南、概念说明、API 参考、排障指南与发布说明。

限制:本项目未提供具体安装命令、价格、平台或效果数据。审查按技术准确性、任务完成、结构、清晰度、可访问性与包容性、一致性分轮进行;审校时给出具体章节与替换建议,不把主观偏好当作缺陷。