笔记巷
参考文档非常适合回答“我如何使用它?”他们更不擅长回答以下问题:
为什么要添加这个功能?
什么样的权衡导致了这种架构?
哪些实验很有希望,但还不稳定?
接下来的项目想要学习什么?
这就是为什么文档现在包含一个单独的Notes通道。
这里有什么
注释是故意不规则的。帖子可以是:
编译器工作一周后的开发日志
新箱子的架构文章
关于 Musea、LSP 或 Vite 集成的设计说明
一个有用的简短项目更新,但不依赖于版本标签
为什么不将所有内容都放在发行说明中
发行说明针对已发布的更改进行了优化。它们应该保持清晰且可操作。
注释为更广泛的故事讲述留出了空间:功能背后的背景、路线图的形状以及帮助读者随着时间的推移理解项目的想法。
写作方向
如有疑问:
如果帖子宣布已发货,请使用发行说明
如果帖子解释了想法、进展或实验,请使用注释