… 很容易成为第二好的就是DEC TOPS-10软件笔记系列，根据我的经验，这是一套20本活页夹，放在一个书架上就包含了运行一个80年代大型小型计算机操作系统所需的一切，包括应用程序。80年代的DEC文档做得非常好的一点是，每一份文档都是由实际用户精心规划和详细设计的，以便专业系统管理员在工作中能够理解。与“销售/市场”驱动的文档不同，软件笔记系列真正了解其读者——专业系统管理员。我还觉得，80年代的DEC文档在技术写作中拥有我见过最好的引言部分。引言被低估了，作者需要在抛出细节之前与读者建立一种“契约”。例如，DEC-10软件笔记系列的第6卷，其中包含ALGOL程序员参考指南，它的引言是史上最棒的。‘这是你开始的地方’应该是文档中最精心设计和撰写的章节，而不是一个填充章节。总之，不要在大纲上偷工减料，也不要偷工减料地写一个真正的引言。
源讨论Ask HN：你见过的最好的软件文档例子有哪些？原帖 96 条评论 · 导入时统计大家好。我目前正在重新设计我正在构建的库的软件文档。我想看看那些能让你轻松找到所需信息的文档示例。谢谢！
完整原文把你的经验，加入这段讨论。
我同意你的观点，但让我们诚实一点，如果你还没有接触过那个世界，这些文档会让你吓一跳。它们绝对不是“容易阅读”的。你对参考类和高度技术性内容的需求程度，以及你是否希望有一个能让你逐步进入新堆栈的内容，将决定你是否欣赏IBM大型机的文档。不过，它们显然不符合现在大多数人对文档的期望。 如果有人想看看它们是什么样子的，可以在Google中输入“IBM zOS v2r5 indexed collection”（最新的文档集）。我其实没有特别推荐的开始阅读的文档，因为如果你不熟悉那个世界，这些文档都不会太容易理解。 《系统编程的ABC》红皮书可能比主文档更适合入门，尽管这些卷册有点...…
完整原文我同意这个观点。Postgresql的文档在当时大型机和小型计算机手册的标准下是足够的——不是特别出色，只是足够而已。如今没有其他文档能与之相比[1]。有很多事情你只能自己尝试。 1. OpenBSD做了一些不错的尝试，但该项目资源不足。
完整原文> 据我所知，那是一套20本活页夹 它们以活页夹的形式出现，因为经常会收到一包新页，有时是几页，有时是几十页甚至上百页，并附有说明，告诉你把它们插入活页夹的什么地方，以及哪些页需要丢弃。 git pull 要容易一点 ;-)
完整原文尊重不同观点，分享具体经验。
登录后即可发帖、评论、转发和引用。