SuperAPI AI 工具集

flutter-documentation

写作与研究

查看项目

更新于 10-16 06:16

技能介绍

用途:为 Flutter 应用生成并维护项目文档,覆盖 README、架构文档、功能文档和入职材料,帮助团队理解、扩展并让新人快速上手。

主要能力:梳理待文档化的内容(新功能、架构决策、发布或入职缺口);先阅读项目现状(README.md、docs/、lib/、pubspec.yaml),避免写出与代码矛盾的文档;从模板中选择合适模板;起草文档并填充必需章节,需用户输入的部分标记 [TODO];校对准确性,确保每个文件路径、命令、类名在当前代码库中真实存在;在引入新命令、环境变量、搭建步骤或架构模式时更新 README;将新功能文档与 docs/architecture/technical_plan.md 或相关 ADR 交叉链接。

文档规则:不得记录与当前代码矛盾的内容;不得未经验证就复制代码示例;README 必须包含 setup、run、test 命令、环境变量列表和目录结构;ADR 为只追加,被取代的决策标注“Superseded by ADR-XXX”而非删除;功能文档位于 docs/features/<feature-name>.md;保持 templates/claude_project_memory.md 最新。

使用方式:按工作流识别文档需求、读取项目状态、选模板、起草、校验、更新 README、交叉链接。产物包括 README.md、docs/architecture/technical_plan.md、architecture_decisions.md、docs/features/<feature-name>.md、docs/product/app_brief.md 及 docs/onboarding/。

限制:资料未提供具体安装命令、定价或平台支持信息,暂未提供。