SuperAPI AI 工具集

document-feature

办公与效率

查看项目

更新于 10-15 21:43

技能介绍

用途:在用户要求为已实现功能编写文档时,分析基础分支的 diff,推断功能边界与名称,生成可观察行为的功能文档。

主要能力:产出 docs/features/<feature_id>.md 与 docs/features.md 索引;功能文档包含 feature_id、title、updated 三个必备 frontmatter 字段;正文按固定顺序包含 What it does、Why it exists、Entry point(s)、Business rules and constraints、Error behavior、Caching、Configuration、Dependencies and interactions 等章节(不适用则省略)。

使用方式:技能面向 Java 服务(Spring MVC 或 Quarkus/JAX-RS)、PostgreSQL、OpenAPI YAML、Kafka、多实例集群部署的后端模块;仓库偏离时尽力而为。命名以行为为准,如 resource-lookup、hold-request-validation;避免以缓存、事件、实现机制命名。仅记录有仓库证据支撑的端点、主题、配置与集成:OpenAPI 规范、application.yml/yaml/properties、代码注解与常量、README 等;无法证明则省略。功能边界或名称确实含糊时只问一个针对性问题。若变更仅为重构、格式化或测试且无外部可观察行为变化,则停止并说明无需更新文档。

限制:不推断“可能”的依赖;不新增 frontmatter 字段(如 owners);不重命名文件;已有索引文件按原风格最小化更新。