formal-docs-landing

Installation
SKILL.md

正式落盘

定义期的最后一步。把定义期定下来的东西分成两类:长期维护的写进正式文档,读代码更快的以源码为文档。这一步完成就进入交接期。

判据

看读代码的效率是否低于读文档。

以源码为文档 写正式文档
应用服务接口、函数签名、类型形状:代码本身说得清 统一语言:词的定义读代码读不出来
单个模块的内部结构 领域边界与职责:谁拥有什么,读代码要翻很多文件
测试用例:它们就是行为的说明 领域协作图与上下文图:关系跨文件跨包
配置项的取值 不变式与它们的守法:散在代码里看不全
形式化的定义、模型与证明,以及它们对应代码的哪些步骤
已定的取舍与为什么不选另一条路

每项设计产出都在落盘决定表里标一个结论,不留「都写一点」。

Installs
1
GitHub Stars
1
First Seen
2 days ago