SuperAPI AI 工具集

absolute-docs

编程与开发

查看项目

更新于 10-16 00:03

技能介绍

用途:把“写点文档”变成读者真正可用的文档。每篇文档只服务一种读者需求,用 Diátaxis 框架分类,沿用项目自身语气与文档栈,并在交付前对照真实代码库校验。支持撰写新文档、按象限标准重写旧文档、审计整个文档站的结构问题。

主要能力:四象限分类(教程、操作指南、参考、解释),三种模式(WRITE、IMPROVE、AUDIT)。WRITE 先侦察代码库与文档栈,再确认文档类型、受众、读者目标与范围,提出文件路径、标题大纲与导航改动,等待明确批准后才动笔。IMPROVE 先判定页面象限,对照标准列出违规项,校验旧片段与版本声明后重写。AUDIT 清点页面、分类、绘制四象限缺口图,输出“页面→现状→象限→动作”的发现表,重构需先获批。

使用方式:从请求判断模式;读取 .absolute.config.json 或 ~/.absolute/config.json 解析配置,否则按标记文件检测文档栈(Fumadocs、Docusaurus、Starlight、MkDocs、VitePress、Mintlify,均无则用纯 Markdown)。按需加载 references/ 下的教程、操作指南、参考、解释、开发者文档、风格语气、文档栈等文件。

限制:不写营销文案、博客或发布公告;不写行内代码注释与 docstring;不编造代码中不存在的功能;不提交 commit,只写文件并报告。文档不足处暂未提供更多细节。