跳到正文

设计

Peri 已批准设计的入口:先分清事实源与状态,再进入总体架构。

更新于 查看 Markdown

主仓库的 docs/design/ 只保存已批准的架构与产品设计,回答“系统应当如何工作”。它不记录调查、迁移批次或完成清单;现行行为由代码、契约测试和复现证明。

状态只有三种:现行设计表示已落地;已批准目标表示尚未完全落地,进度写 spec/issues/;待重构表示目标已收敛、实现差距已审计。

读设计前先分清
三种材料,三种问题

同一句话可能在说现状、规则或目标。


设计

系统应当如何工作。允许写已裁决但尚未完全落地的目标,并在文首标明状态。


规则

跨模块可执行约束。用稳定 ID、Scope、Rule、Verify 定位,不复制设计叙事。


事实

代码、契约测试与可复现结果证明现行行为。设计不能把目标写成现状。

状态怎么读

状态写在文首,进度写在 spec/issues。


现行设计

已落地的稳定结构;具体符号与入口以代码索引和源码为准。


已批准目标

已经裁决但尚未完全落地;实现进度与验收只写对应 issue。


待重构

设计已收敛、实现差距已审计;作为重构基线,范围与顺序见 active issue。

从这里开始

维护边界

  1. 新设计先确定状态、scope、代码事实源和对应 active issue。
  2. 实施完成后删掉进度叙事,只把稳定结果同步为“现行设计”。
  3. 文件改名、合并或删除时,同步根/模块路由、standards、code-index 与 active spec 引用。
  4. 动态 inventory、固定源码行号和命令输出不复制进设计;定位信息放 docs/code-index/。

事实源

本页是贡献者入口,不替代主仓库文档。发生冲突时,按代码与契约测试、docs/standards/、模块指引、docs/design/、active spec、历史记录的顺序判断。

导航

输入以搜索…

↑↓ 导航↵ 选择Esc 关闭