Use when you need `jjk-api-doc-sync` in this repository. Source intent: API 文档同步门禁:接口变化时始终自动同步 API 文档;产品/设计文档仅按发布标志扩展同步
$jjk-api-doc-sync 负责在接口契约变化时,先把API 文档同步清单说清楚。
publish_product_doc=true 时同步;publish_design_doc=true 时同步;requirements/design/plan/uat_cases 不受本命令控制,它们本来就必须存在。至少提供以下输入之一:
design.md / implementation_plan.md 中的 API 影响说明。失败时:
API_DOC_SYNC_SCOPE_UNCLEARAPI_DOC_SYNC_MAPPING_MISSINGAPI_DOC_SYNC_ORDER_FORBIDDEN至少检查:
app/api/**、app/schemas/**、前端 API 调用层;至少输出三栏:
Must UpdateShould ReviewNot In Scope基础映射规则:
docs/API文档/接口文档.md 必须进入 Must Update;Must Update 或 Should Review;publish_product_doc=true 时,正式产品/需求文档进入 Must Update;publish_design_doc=true 时,正式设计/架构文档进入 Must Update。必须输出:
Must Update / Should Review / Not In Scope 清单;api_doc_required=true|false;publish_product_doc / publish_design_doc 状态;sync_status=READY|BLOCKED|NOT_APPLICABLE。--doc 就跳过 API 文档;$jjk-design -> $jjk-api-doc-sync -> $jjk-plan
$jjk-imp -> $jjk-api-doc-sync -> $jjk-verify
$jjk-api-doc-sync
使用 $jjk-api-doc-sync 触发。目标是“API 文档自动同步、正式文档按发布标志扩展”,不是“一刀切全改”。