埏埴以为器,当其无,有器之用.
通过工艺将泥土塑造成陶器,但正是其中的空虚才使得陶器有用处。
- 老子
目录
可扩展性和互操作性比一堆不必要的特性更重要。 规模来自简洁、速度和易用性。 互操作性来自朴素、易于理解的内容。
更少的干扰造就更好的写作和更高效的阅读。
新功能绝不应干扰最简单的使用场景,并且对于不需要它们的用户应保持不可见。
Markdown 是为普通工程师设计的——忙碌的、只想回到编码的工程师。 大型而复杂的文档是可能的,但不是主要关注点。
最小化上下文切换使人们更快乐。 工程师应该能够使用与阅读和编写代码相同的工具来与文档交互。
纯文本不仅足够,而且更优越。 Markdown 本身对于这个公式不是必需的,但它是目前最好和最广泛支持的解决方案。 一般不鼓励使用 HTML。
内容和呈现不应混杂。 始终应该可以放弃渲染器并在源头读取基本信息。 用户永远不应该接触演示层,如果他们不想的话。
可移植性和面向未来的设计为即将到来的、未曾想象的集成留出了空间,并且最好通过保持源代码尽可能易于人类阅读来实现。
静态内容比动态内容更好,因为内容不应依赖于任何一个服务器的特性。 然而,新鲜胜于陈旧。 我们努力平衡这些需求。
文档像测试一样受到对待时,它们会蓬勃发展:一种必要的苦差事,人们学会品尝,因为它会随着时间的推移而得到回报。 参见 最佳实践。
简短实用胜于冗长详尽。 绝大多数用户只需要作者总知识的一小部分,但他们需要快速且经常地获取这些知识。
渐进式改进胜于旷日持久的辩论。 对不完美的耐心和容忍允许项目有机地发展。
不要舔饼干,传递盘子。 想法很廉价。 我们正淹没在潜在的具有影响力的项目中。 只选择你真正能处理的,并发布你无法处理的。