SuperAPI AI 工具集

fstack-document

写作与研究

查看项目

更新于 10-15 21:42

技能介绍

用途:为当前项目在 docs/ 下生成三层 Markdown 文档,从 ELI5 通俗概览到深入参考。首次运行创建文档,再次运行按代码现状更新。

主要能力:生成三个文件——docs/overview.md(用非专家能懂的语言说明项目是什么、做什么、给谁用,不用术语);docs/architecture.md(主要组成部分、如何组合、数据如何流动、影响设计的决策);docs/reference.md(目录与关键文件、配置与环境、如何运行、测试和构建)。

使用方式:用户调用 /fstack-document。技能先读取项目结构、入口点、主要模块、数据模型、配置及运行测试方式;检查 docs/ 是否已有该文档集。没有则进入创建模式;已有则进入更新模式,重新读取项目、与现有文档对比,只改代码变化的部分,保留仍然成立的人工编辑,不从头重写。完成后给出简短摘要;更新模式说明新增、修订及代码中已移除的内容。

适用场景:项目几乎没有文档;文档存在但已与代码脱节;用户主动调用该技能。

限制:必须保持三层三文件,不扩散成多个文件;不得编造行为,只记录代码实际所做,不清楚就说明而非猜测;不重写代码未改动的文档;不得包含密钥、令牌或 .env 值。文档需与当前代码一致,而非 git 历史或变更日志;文档提到的文件、模块或功能若已不存在,应标记并删除该部分;代码中新增而文档遗漏的内容应补入对应层级。