SuperAPI AI 工具集

documentation

办公与效率

查看项目

更新于 10-15 17:12

技能介绍

用途:为项目建立强制的文档标准,要求文档随代码一同交付,避免变更日志、功能规格和模块文档被跳过或事后补齐。核心原则包括文档随代码发布、以 /Documentation 文件夹为唯一参考、支持智能体跨会话延续上下文、文档保持最新。

主要能力:定义语义化版本(MAJOR.MINOR.PATCH)与发布命名规则 vX.Y.Z — [Program] / [Module]: [Feature],以及机器友好的范围标签 scope: program.module.feature;规定兼容性规则和 /Documentation 目录结构(project-roadmap.md、architecture.md、changelog.md、features/[program]/[module]/ 下的模块说明与功能规格)。同时规范根 README 的十个章节顺序(标题与一句话简介、快速开始、功能能与不能、前置条件、安装、用法、项目结构、配置、故障排查、贡献),强调每步给出预期结果、诚实列出依赖版本、用真实名称而非占位符。功能规格必须包含一句话描述、模块引用与状态、用户故事、概览、可测试验收标准、数据模型、技术说明与标准清单、开放问题、相关功能。变更日志遵循 Keep a Changelog 的 Added/Changed/Deprecated/Removed/Fixed/Security 类型,状态在路线图用 emoji、在功能文件用文本。

使用方式:构建者先读 Builder Checklist 再开工,将文档与代码一同规划;重构者用 Enforced Rules 查找文档缺口。可按模板 assets/ 下的 feature-template.md、module-template.md、changelog-template.md、readme-template.md 创建,用 scripts/validate_docs.py 校验结构,用 scripts/generate_feature.py 生成功能文件,详细指南见 references/ 下对应文档。

限制:资料明确说明文档标准目前没有确定性 linter 强制执行,Enforced Rules 表中尚无自动规则,所有检查均通过上述 Builder Checklist 手动完成;后续添加检查器时再注册规则。除给出的模板、参考与脚本外,具体平台、收费与效果暂未提供。