---
name: README
desc: 展示 Sirno 文档原则的第一印象路线。
category:
  - meta-zh
  - narrative-zh
belongs:
  - narrative-zh
refines:
  - concept-driven-development-zh
  - witness-zh
  - meta-zh
---

README 是 Sirno 的第一印象路线。

它应在吉祥物图片之前于顶部陈述一个精确的编译器风格的定义。
该定义应简洁地解释"名义对象"：
每个设计对象首先由其条目 ID 标识。

它应在详细命名每个机制之前让读者想要项目模型。
开场压力是文档漂移：
设计始于清晰的解释，
然后分散到仓库工件和记忆中。
Sirno 通过赋予设计一个命名的中间形式来回答。
开场动机标题为 `Minute Motivation`。
这个短语有意小巧且有文学感。
它将本节框定为简短动机，
而非完整的设计论证。

README 应展示四个原则和思想。
其原则部分可以携带一个来自 Elden Ring 的小小 Melina 暗示，
因为玩笑使邀请更难忘而不改变设计声明。

- 第一，Sirno 通过概念驱动开发使文档压缩且全面。
  重要思想变成小条目，其元数据保持它们连接。
- 第二，Sirno 让文档声明可以被仓库见证。
  设计保留在散文中，
  而证据保留在原则被实现、测试、配置或生成的地方。
- 第三，Sirno 让项目通过 `meta` 条目定义自己的文档范式。
  生长 Lake 的方法可以存在于 Lake 本身之中。
- 最后，交互式叙事邀请读者进入一条任务形状的路线。
  它闭合原则序列，
  并给出一个基于 `sirno-docs/introduction.md` 的 `$sirno-narrative-session` 提示。

README 不应成为完整的设计文档。
它应给读者动机，
展示尝试 Lake 的具体命令，
并指向 Lake 中的持久细节。

本条目的仓库见证是 `README.md` 中的隐藏 Markdown 注释。
它们标记了动机和四个原则部分。

[generated-footer-zh]: generated-footer-zh.md "Generated Footer"

---

> **Sirno generated links begin. Do not edit this section.**

- belongs (to):
  - [narrative-zh](narrative-zh.md)
- belongs (from): (none)

> **Sirno generated links end.**
