SuperAPI AI 工具集

altitude-docs

写作与研究

查看项目

更新于 10-16 01:19

技能介绍

用途:用于编写、重构、润色或评审文档页面,包括教程、快速入门、操作指南、参考页、解释页与落地页。核心是「高度」:从「为什么存在」到「精确边界情况」的受控下降,每种页面允许不同深度区间,如教程停留在高处,参考页位于低处。技能只治理页面如何构建,不决定内容是否真实,API 名称、符号与行为需依据当前仓库核验。

两种模式:Author(页面尚不存在,从第 1 步执行完整流程);Polish(页面已存在,按差异执行:识别原型,找出偏离高度区间或违反契约之处,只修该处,不重写已通过标准的页面)。

使用前先适配仓库:确认文档根目录、目录与 Diátaxis 原型的映射、真实代码来源、可运行示例来源、构建与本地预览命令(干净构建应为零警告零错误)、组件系统与项目风格。

五个高度带依次为:1 定向(为何存在、解决什么问题)、2 心智模型(一两句或一个图)、3 代码形态(最小真实锚点)、4 机制(API 表面、方法与选项表)、5 边界与运维细节(注意事项、失败模式、调优)。页面不得回跳或跳过所属原型必需的高度带。

完成标准包括:单一 Diátaxis 职责、frontmatter 完整、按开场契约开头、按顺序下降且不越过下限、组件使用有理由、代码尽可能取自示例、按交接契约结尾、第二人称现在时主动语态、所有 API 符号经核验、干净构建通过。

参考资料包括 references/altitude.md、contracts.md、procedure.md、vocabulary.md、components.md、exemplars.md。相关技能有 rfc-writer、keep-a-changelog、python-google-docstrings、python-rest-docstrings。

限制:资料未提供具体安装命令、收费价格、支持平台与量化效果;具体仓库约定需自行检查或询问用户。