spec-for-ai:基于Spec驱动开发的AI编码实践知识库项目

可帮助团队通过结构化规格约束AI编码行为,实现需求到迭代的自循环工作流。整理了业界主流SDD实践,包含工作流、光谱理论等核心文档及模板示例,助力解决AI猜测需求、质量不可控等问题。【此简介由AI生成】

分支9Tags0
当前项目代码仓暂无内容

OpenHarmony AI辅助规格化开发实践库

项目定位

本工程不是为了单纯研究 Spec-Driven Development(SDD)概念,而是基于业界 AI Coding、Spec 驱动、需求工程、架构设计文档、质量门禁等实践,提炼并导出一套适合 OpenHarmony 大型多仓工程 的 AI 辅助设计、开发和测试流程。

核心目标是把“业界优秀实践”落到 OpenHarmony 的真实工程约束中:

  • 多仓协作、跨子系统和跨 SIG 协调
  • 需求从原始输入到稳定基线的澄清机制
  • Feature 级架构设计先行,再展开 Spec 和 Task
  • DeepWiki/MCP/Skill 驱动的上下文工程
  • AI 生成代码前的明确边界、约束和验收标准
  • 质量门禁、测试追溯和试点复盘闭环

换句话说,本仓的核心产出是 openharmony/ 下的 OpenHarmony 适配版流程、模板、质量体系和试点执行包;通用 SDD 文档是方法来源和参考素材。

核心产出

OpenHarmony落地实践

目录/文档 作用
openharmony/README.md OpenHarmony SDD工作流入口
openharmony/docs/01-业务流设计.md 从原始需求、需求基线、Feature Design到AI实现和合入的完整流程
openharmony/docs/02-分级流程指南.md 简单-关键四级流程、升级/降级和AI自闭环边界
openharmony/docs/03-设计约束与规范.md OpenHarmony分层、API、构建、编码、测试最低约束
openharmony/docs/04-上下文工程.md DeepWiki MCP、源码和官方文档如何进入Spec和Design
openharmony/docs/05-质量评估体系.md 4 阶段质量门禁、指标和Benchmark设计
openharmony/docs/07-简单-标准试点执行手册.md 首批试点可直接执行的操作手册
openharmony/tools/integrations/agent-tooling.md Claude Code / opencode 插件化、Skill和命令集成指南
packaging/README.md Claude Code / OpenCode / Codex 三端分发骨架和最小插件包
openharmony/workflow/profile-driven-workflow.md 通用核心层和子系统定制适配的流程演进设计
openharmony/workflow/spec-repository-structure.md 业务代码仓 .specs/ 目录、命名、追溯和新旧设计识别规则

模板体系

新模板 12 个,按 4 阶段工作流组织:

阶段 模板 用途
定义 proposal.md 三合一需求文档(原始需求→澄清记录→需求基线)
规格化 design.md 架构设计 + 可选设计扩展区段
规格化 spec.md 特性行为规格、AC、API、兼容性和测试追溯
规格化 epic.md 复杂/关键级跨仓跨SIG特性规划
规格化 scenario-library.md 二合一 Gherkin 场景库
实现 execution-plan.md 执行计划 + 交接信息
实现 task.md AI 可执行的最小实现单元
实现 bugfix.md 缺陷复现、根因、修复和回归测试规划
实现 regression-test.md 回归测试规格
审查 review.md 四合一审查(架构+规范+质量+决策)
全阶段 gate-checklist.md 阶段检查清单
全阶段 CLAUDE.md Agent 指令

工具和样例

  • openharmony/tools/scripts/spec-validate.sh:Spec必填项和格式校验。
  • openharmony/tools/scripts/quality-report.sh:按文档类型生成质量评估报告。
  • openharmony/examples/:Feature和Bugfix完整样例,可用于试点演练。
  • openharmony/context-engine/:DeepWiki查询模板、仓库索引和OpenHarmony领域Skill。

方法来源

本工程吸收了以下实践,但不照搬某一套方法:

  • 需求工程:原始需求、澄清讨论、需求基线、范围内/范围外、验收标准和变更控制。
  • 用户故事与验收:Card / Conversation / Confirmation、WHEN/THEN、可测试AC。
  • 架构设计实践:Design Doc、RFC、ADR、Architecture Runway,先确定架构约束和关键决策,再拆Spec。
  • AI Coding实践:Rules + Spec + Skills、Agent上下文注入、AI自闭环入口条件。
  • 质量工程:QG质量门禁、测试追溯、DORA/AI生成质量/Spec质量指标。

通用资料沉淀在 docs/templates/examples/references/ 中,作为 OpenHarmony 流程设计的参考基线。

目录结构

.
├── openharmony/              # 核心:OpenHarmony适配版流程、模板、工具和样例
├── packaging/                # Claude Code / OpenCode / Codex 分发骨架
├── docs/                     # 通用SDD、AI Coding和工程实践调研资料
├── templates/                # 通用模板
├── examples/                 # 通用示例
├── references/               # 参考资源链接
└── README.md                 # 本说明

推荐阅读路径

如果目标是落地 OpenHarmony 试点,按以下顺序阅读:

  1. AGENTS.md
  2. openharmony/README.md
  3. openharmony/docs/07-简单-标准试点执行手册.md
  4. openharmony/templates/proposal.md
  5. openharmony/templates/design.md
  6. openharmony/templates/spec.md
  7. openharmony/templates/task.md

如果要理解方法来源,再阅读 docs/ 下的通用实践文档。

当前状态

当前重点已经从”调研SDD是什么”转向”把可执行的OpenHarmony试点流程跑起来”。下一步建议围绕真实 OpenHarmony 仓库选择 2 个简单任务和 1 个标准任务,使用 openharmony/docs/07-简单-标准试点执行手册.md 完成端到端试点,并把复盘结果反向更新模板、Skill和质量门禁。

参考资料

完整参考列表见 references/参考资源链接.md

项目介绍

可帮助团队通过结构化规格约束AI编码行为,实现需求到迭代的自循环工作流。整理了业界主流SDD实践,包含工作流、光谱理论等核心文档及模板示例,助力解决AI猜测需求、质量不可控等问题。【此简介由AI生成】

定制我的领域