Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.36 KB

best_practices.md

File metadata and controls

27 lines (16 loc) · 1.36 KB

文档最佳实践

简单而直接地说出你的意思。 —— Brian Kernighan

最小可行的文档

一套精练、新鲜而准确的文档要比无序、松散而处于失修状态的文档更好。

编写简短而有用的文件。删掉一切不必要的东西,同时养成不断修改和改进每份文件的习惯,以适应你不断变化的需求。就像一棵盆景树,文件在有生命力但经常修剪的情况下效果最好。

识别你真正需要的东西,频繁地、小批量地删除垃圾。

删除「死文档」

「死文档」(过时、无用的文档)是不好的。它们会误导人,会拖慢速度。如果你的家是干净的,大多数客人不用问也会很干净。

就像任何大的清洁项目一样,如果你的文档状况不好,很容易让人崩溃:

  • 慢慢来,文档健康是一个逐步积累的过程
  • 首先删除你确定有问题的东西,忽略不清楚的东西。
  • 让整个团队参与进来,花时间快速扫描每份文件,并做出简单的决定:保留还是删除?
  • 不断迭代。

不要过度追求完美

你的文档应该在合理的时间范围内尽可能地写好。文档从来都不是完美的,随着团队了解到他们真正需要写下的东西,文档质量往往会逐渐改善。