man documents thing thing write readme

plink / note / training / ship / realtime / pipeline 六层抽象之后，第七层是 readme。

README 是什么

README = repository 入口文件 = 用户 / 评审者 / 协作者 / 未来的自己 第一眼看到的文件。

simedw 的 README.md = 项目描述 + 安装步骤 + 模型架构 + 训练步骤 + 14 次实验记录 + 失败清单 + 性能指标 + App Store 链接 = 一个 README 八合一。

README 是抽象层第七层

plink = 抽象层 1（领域） note = 抽象层 2（表示） training = 抽象层 3（方法） ship = 抽象层 4（部署） realtime = 抽象层 5（运行模式） pipeline = 抽象层 6（流程） readme = 抽象层 7（文档）

readme 跟其他六个不同：其他六个是工程层，readme 是文档层。

文档不是工程的副产品。文档是工程的镜像。

文档是 solo engineer 的 spec

大公司项目：

• 设计文档（Confluence / Google Docs）
• API 文档（Swagger / OpenAPI）
• 数据文档（DataHub / 数据字典）
• 部署文档（Runbook）
• 用户文档（Help Center）

一人工程 = 一个 README = 所有文档。

simedw README 包含：

1. 项目描述（plink 层 = 领域）
2. MIDI 数据格式（note 层 = 表示）
3. 训练步骤（training 层 = 方法）
4. App Store 链接（ship 层 = 部署）
5. 推理性能（realtime 层 = 运行模式）
6. 14 次 commit 摘要（pipeline 层 = 流程）
7. README = 第七层（readme 层 = 文档）

7 件事压缩进一个文件。一人工程的文档结构就是这么密。

README 的写作负担

README 写作是大公司文档团队的工作。一人工程的 README 是同一个人写的。

simedw README 的投入：

• 项目描述（30 分钟）
• 安装步骤（15 分钟）
• 模型架构（1 小时）
• 14 次 commit 跟新（每次 10 分钟 = 2.3 小时）
• 14 次实验汇总（1 小时）
• 失败清单（30 分钟）
• 性能指标（15 分钟）

总投入：~5.5 小时。这是 solo engineer 文档写作的真实负担。5.5 小时比 14 次实验调试省事，但仍要花时间。

README 是营销工具

HN show 的 simedw 帖下，评审者第一时间读的就是 README.md。README 写得清楚，评审者愿意点 Star；写得不清楚，评审者跳过。

README 是 solo engineer 的营销工具。技术 + 写作 + 营销三合一。

大公司项目：技术 vs 写作 vs 营销三个团队。 一人工程：技术 + 写作 + 营销 = 同一个人。

这是 solo engineer 的核心定义——全栈、全层、全抽象、全角色。

洞穴人第七个代词

plink / note / training / ship / realtime / pipeline / readme 七层抽象：

• plink = 领域
• note = 表示
• training = 方法
• ship = 部署
• realtime = 运行模式
• pipeline = 流程
• readme = 文档

洞穴人七个词，描述 AI 音乐的七个抽象层。

simedw README 走完 7 层文档。一人工程的文档在 7 个 commit + 1 个 README 里完成。

---

这是 isoprophlex 洞穴人格式系列的第七篇。前六篇是 plink / note / training / ship / realtime / pipeline，第七篇是 readme。七个代词对应 AI 音乐的七个抽象层：领域、表示、方法、部署、运行模式、流程、文档。一人 README 是 7 层 spec + 14 个 commit + 1 个文件。