跳转到主要内容
使用本指南编写长期有效的实验室页面。

文章应放置在哪里

  • foundations/
  • patterns/
  • systems/
  • ecosystem/
  • case-studies/
根据主题选择分类,而不是根据启发草稿的源章节来选。

必需结构

每篇文章都应遵循: 必需部分:
  • Summary
  • Why It Matters
  • Mental Model
  • Architecture Diagram
  • Tool Landscape
  • Tradeoffs
  • Citations
  • Reading Extensions
  • Update Log

工作规则

  • 使用仓库原生英文撰写。
  • 概念和引用使用来源输入,而不是直接保留其行文。
  • 保持图示简洁,并由仓库自有内容维护。
  • 链接到相关的实验室页面,使文章成为更大地图的一部分。
  • 保持页面具有长期适用性。如果某个说法很可能很快过时,要么验证它,要么 用不依赖时间的语言来写。

完成标准

当一篇文章满足以下条件时,即可进入审阅:
  • 与该分类清晰匹配
  • 遵循元数据和章节模板
  • 引用了主要来源
  • 避免照搬上游教学流程
  • 至少包含一个有用的内部阅读链接