标签: documentation

我们解决了许多服务器和网络问题，并遵循一组松散的步骤来解决不同情况下的操作。随着越来越多的人和责任，标准化的需求是必要的，所以我们不会错过任何东西。

我知道我可以使用流程图完成我想要的事情，但我想做一些类似于“选择你自己的冒险”风格的事情。我认为这与支持呼叫中心似乎所做的几乎相同。

是否有任何工具可以使创建此类文档更容易？如果可能，我正在寻找一种基于网络的方法。

我的团队需要在内部发布文档。目前，它遍布各地，这意味着我们经常不得不到处搜索才能找到一些东西。

我们想在一个地方发布所有内容。阻止我们的主要因素是访问控制——现有的 wiki 不属于我们，我们也做不到。

发布文档的最佳工具是什么，最好满足以下要求：

• 网络前端 - 读者使用浏览器访问文档
• 放置文档的单一位置
• 通过单个文档或文档集（文件夹、“站点”分支等）进行访问控制
• 如果您无权访问文档，则看不到该页面/文档/文件夹的链接。
• 内置编辑器或我的用户熟悉的东西（例如 Word）
• 内置版本控制会很好

另外，你能想到我应该指定的其他标准吗？

有人可以指出我对 Linux I/O 系统的相当完整的参考，主要是如何处理和刷新所有缓冲区和缓存？

到目前为止，我的理解是有

• 应用程序缓冲区（包括由 libc 分配的 fread/fwrite 缓冲区）
• 读取和写入操作的 VFS 缓冲区
• 已映射的页面（与 VFS 缓冲区相同？）
• 特定于文件系统的缓冲区（与 VFS 缓冲区相同？文件系统至少提供了一些策略，例如 XFS 对写入缓存更积极）
• 在转换为 SCSI/ATA 命令并传递给...之前，磁盘驱动程序可能有一些缓冲区。
• 磁盘控制器可以具有易失性、电池供电或无缓存。刷新易失性缓存的机制是什么？障碍因素如何影响？
• 磁盘本身可以有一些缓存，具有与控制器相同的刷新问题。

显然，这是一个相当混乱的帐户，但希望它显示了我正在寻找的信息类型。我发现 Linux 内部文档非常稀少；也许有一本好书涵盖了所有这些？讨论缓冲区复制与传输的位置也很好。

我经常拨打这样的电话：

get-help <some-command>

在 Powershell 2 中。对于这些命令中的许多（但不是全部），我没有看到帮助条目的内容。相反，我得到重复项，并且仅显示帮助对象本身：

[PS2]> get-help remove-distributiongroup | more

Name                              Category  Synopsis
----                              --------  --------
Remove-DistributionGroup          Cmdlet    Use the Remove-DistributionGroup...
Remove-DistributionGroup          Cmdlet    Use the Remove-DistributionGroup...

作为一个完全的 PS 新手，我通过执行类似于以下的操作来解决这个问题：

[PS2]> $var = get-help remove-distributiongroup
[PS2]> $var[0] | get-member
... Output ...
[PS2]> $var[0].Parameters |more
... Part of the documentation ...
[PS2]> $var[0].Synopsis |more
... Another part of the documentation ...

有几个问题。

• 我的 Windows 管理员同事知道如何删除重复条目吗？我只是一个 Unix 人。
• 如果没有，是否有一种更简单的方法来获得我需要的东西，而不是我上面想出的复杂的黑客方法？

谢谢！

[更新[：

尝试了pk的建议，但遗憾的是这没有用。这是通过 select -unique 进行管道传输时的输出：

Name                              Category  Synopsis
----                              -------- …

我必须记录我使用的服务器，但我不知道用什么来保存数据。您能否建议保留服务器文档的最佳方式？我是创建一个包含硬件和软件文档的数据库，还是使用 wiki 页面或 SVN？或者，如果有保存文档的工具，请提供链接。