4.7 KiB
Raw Permalink Blame History

Implementation Plan: [FEATURE]

Branch: [###-feature-name] | Date: [DATE] | Spec: [link] Input: Feature specification from /specs/[###-feature-name]/spec.md

Note: This template is filled in by the /speckit.plan command. For this project, planning is document-first and multi-repo aware.

Summary

[Extract from feature spec: primary requirement + target documents + intended update approach]

Repository Scope

  • Formal workflow home: water-docs
  • Target repos in scope:
    • water-docs: [Yes / No]
    • water-backend: [Yes / No]
    • water-frontend: [Yes / No]
  • Primary delivery mode: [Document closure / Code evidence alignment / Backend implementation / Frontend implementation / Mixed]

Code Baseline

  • Backend baseline: [commit SHA / branch / N/A]
  • Frontend baseline: [commit SHA / branch / N/A]
  • Baseline capture plan: [How code evidence will be tied to a stable commit]

Technical Context

Primary Work Product: [Markdown design docs, management docs, evidence files, backend code, frontend code] Source of Truth Documents: [List the authoritative docs that this change must align with] Reference Sources: [Archive/guides/other references allowed for verification] Validation Commands: [e.g., make validate-file FILE=..., make check-links, make validate-mermaid, compile/build/test commands] Target Scope: [specific chapters, main docs, code modules, or verification slices] Project Type: 文档治理仓库 + 多仓实现协作 Constraints: [no new parallel formal docs, no invented business rules, relative links only, branch rules, baseline rules] Scale/Scope: [single document / cross-document / multi-repo / verification-heavy]

Constitution Check

GATE: Must pass before Phase 0 research. Re-check after Phase 1 design.

  • 主文档归属已确认:正式结论优先落在 water-docs 既有主文档或治理文档,不新增平行正式稿。
  • 多仓范围已确认:已明确本轮是否涉及 water-backendwater-frontend,以及各自只是取证还是需要改代码。
  • 代码基线已确认backend/frontend 的 commit 或 branch 基线已记录,避免文档结论失去实现版本锚点。
  • Archive 使用方式合规Archive 仅作为来源/核对输入,不直接替代正式口径。
  • 一致性影响已列出:已识别系统名称、数据库口径、编号、图表、链接、术语、接口契约等受影响项。
  • 校验与台账动作已规划已明确需要执行的文档校验、代码验证、evidence 更新,以及是否需要更新 01_Project_Progress.md / 03_Task_Checklist.md

Project Structure

Feature Artifacts

specs/[###-feature]/
├── spec.md
├── plan.md
├── research.md
├── data-model.md
├── quickstart.md
├── contracts/
├── tasks.md
└── verification.md / final-verdict.md

Repository Touchpoints

water-docs/
├── docs/design/
├── specs/
└── .specify/

water-backend/
└── [backend modules in scope]

water-frontend/
└── [frontend modules in scope]

Structure Decision: [Document the exact files or modules to be updated and the reason each is in scope]

Phase 0: Research & Alignment

Research Inputs

  • [List unresolved questions about docs, backend, frontend, baseline, or validation]

Deliverables

  • research.md
  • [Optional evidence note if brownfield code audit is required]

Phase 1: Design & Contracts

Planned Artifacts

  • data-model.md
  • contracts/*
  • quickstart.md
  • verification.md or final-verdict.md if the feature is verification-heavy

Design Decisions

  • [List the intended docs-first and multi-repo decisions]

Validation Plan

  • Document validation: [make validate-file / check-links / mermaid checks]
  • Backend validation: [compile / unit test / smoke / N/A]
  • Frontend validation: [build / lint / typecheck / smoke / N/A]
  • Evidence output: [baseline.md / docs-validation.md / backend-validation.md / frontend-validation.md / final-verdict.md]

Ledger Sync Plan

  • Project progress update required: [Yes / No]
  • Task checklist update required: [Yes / No]
  • Evidence or verification summary update required: [Yes / No]

Complexity Tracking

Fill ONLY if Constitution Check has violations that must be justified

Violation Why Needed Simpler Alternative Rejected Because
[e.g., temporary appendix doc] [current need] [why existing main doc could not safely absorb it]
[e.g., Archive citation exception] [specific traceability reason] [why normal main-doc source was insufficient]