随着时间的推移，我为各种客户承担了咨询和合同工程工作。最近，客户要求提供某些类型的文档。
- 对于我们正在安装的新网络时钟，我可以使用哪些静态 IP 地址？
- 如何在网络过滤器中设置排除项？CEO 无法访问NRA 网站再也没有了！！
- 我们需要关闭 Linux 服务器以应对计划停电。命令是什么？
这些都是小型企业，通常没有专门的技术人员。在单个公司中，Wiki/Confluence/Sharepoint 等都可以作为文档和环境信息的中央存储库，但我很难找到一种一致的方法将这些信息传递给离散的顾客。
我追求的是一种比简单的电子表格或可怕的满是过时信息的文件夹。
- 重要的 IP 地址、DHCP 范围等。
- 网络图（如果需要）。
- 管理用户名和密码以及管理 URL。
- 软件许可证密钥。
- 支持合同和保修信息。
- 供应商支持联系方式和说明。
我知道这里还有其他顾问。有没有关于以客户友好格式在多个环境中维护文档的建议或提示？你做吗？
答案1
自 2004 年 6 月以来，我一直是一家三人承包/咨询服务的合伙人。我们每个人主要负责自己的“帐户”，但我们需要为彼此维护文档，以便合作伙伴之间进行“故障转移”。我们的大多数客户都有某种内部 IT 员工，其中许多人执行一定数量的日常维护工作，我们也需要有效地向他们传达文档。
我的两个合伙人有一个优势（如果你可以这样称呼的话），他们曾在另一家公司担任过我的下属，因此，他们都接受了我固执己见的做事方式。客户配置之间的严格一致性（显然，事情可以在哪里）是天赐之物。显然，产品会发生变化，因此我们会召开会议讨论新产品/版本等，并在部署之前决定一致的配置策略。这不会扩展到大公司，但坦率地说，我认为这是一种功能而不是缺陷。（我不会开始抱怨大型“托管服务”公司，他们的员工是“工程师”，并且倾向于一次性、半心半意的“解决方案”，以及客户之间的不一致......>微笑<）
我是猛烈地反对“可怕的活页夹”。我从未见过物理文档保持最新曾经。我认为花时间制作文档的物理副本是浪费客户的钱。我宁愿花时间研究如何根据运行配置的“实时”数据生成文档。
举个例子，我绝对会不是维护 IP 地址信息电子表格。这就是 DHCP 和 DNS（详情见下文）的作用。如果这些东西不起作用，那么我们就会遇到大问题。
我们曾有客户要求我们做类似“制作一份显示所有组策略配置的文档”这样的事情，而我却坚持拒绝这样做。我反复提出的反建议（到目前为止有效）是向客户介绍可以为他们提供“自助服务”的管理工具，或者使用软件按需生成“实时”的客户友好文档。
我们非常努力地用简单的英语一丝不苟地解释清楚。例如，非技术 IT 联系人可以查看计算机的 Active Directory 组成员身份，并看到诸如“软件 - 安装 Microsoft Office 2010 Pro”和“组策略 - 发货亭计算机自动登录”之类的内容。不需要任何文档来解释这些内容的含义。
以下是我们使用的一些“实时”数据：
全部IP 地址分配存储在 DHCP 服务器中——这也包括静态寻址设备（注释中已注明）。MAC 地址和 IP 地址可通过脚本或手动轻松查询，并且根据定义，如果在生产中使用数据，则数据必须是最新的。
一切在 DNS 中获取名称和 PTR 记录。大多数主机还会获取 HINFO 记录。需要详细描述的内容会获取 TXT 记录。
在任何可能的地方大量且详细地使用“注释”字段 - Active Directory、计算机描述、共享文件夹描述等。我们对安全组名称等内容也十分详细和清晰。
网络设备配置中的注释/备注（例如，ACL 的注释、端口的描述、SNMP 位置/联系信息）。
我对在文本文件、wiki 等中自由存储信息的想法持相当负面的态度。结构化使搜索更方便。只要我能让结构化的存储机制为我工作（即使这意味着我必须编写软件来查询它），我就会更喜欢它。与几乎立即过时的手动生成的文档相比，我能从配置文件、数据库等中解析出的注释总是让我信服。
当我们必须存储“自由格式”信息时，我们会使用自己的 SVN 存储库。它包含我们多年来创建的所有静态文档的各个部分，由客户归档。自 2004 年以来，我们一直在使用 SVN 进行此操作，它作为我们的协作工具非常有效。我们对数据库架构、系统管理员脚本、组策略对象备份等进行版本控制。我尝试将我能检查到的所有内容都纳入版本控制。
使用基于文件系统的索引工具搜索我的结帐非常容易。我知道我们每个人在本地随时都可以使用至少一个完整的存储库副本。我们还通过 SSL 上的经过身份验证的 WebDAV 使存储库可访问，以防我们必须获取存储在那里的数据并且只能通过浏览器访问。
我们从未被要求这样做，但我们很乐意在 SVN 服务器上创建一个帐户，以允许客户签出并与自己的文件交互（如果他们有内部资源愿意的话）。我们使用标准化格式来存储所有静态客户文档（软件许可文档、购买记录等），这是非常不言自明的。
除了 SVN 存储库，我们还自行托管电子邮件。自公司域开始接收电子邮件以来，所有传入/传出的电子邮件都已存档。它以 BSMTP 日志的形式提供给合作伙伴以供参考（我个人认为它非常有价值）。这种情况从未发生过，但我知道，如果客户要求，我们会很乐意让客户访问其与员工之间的任何通信日志。提供合作伙伴之间的内部通信将更加困难，因为我们可能会在同一条消息中引用多个客户。（我们可能应该在这方面做得更好，但我们还没有做到。）
密码是我们流程中的一个主要“缺陷”。我们为每个客户使用单独的“密码保险箱”存储库（具有唯一组合），以便与客户共享保险箱文件。我们将所有保险箱文件的主密码保存在另一个保险箱文件中，密码组合只有合作伙伴知道。这部分确实需要一些工作。我想我们希望让每个客户使用真正的多用户密码保险箱应用程序（带有审计跟踪等）托管一个现场凭证保险箱，但我们已经将这个想法搁置了近 10 年。
我们的时间跟踪记录非常详细，并以客户想要的任何电子格式提供给他们（到目前为止，一直是 ASCII 文本和 PDF）。客户可以获得每个计费事件的开始/结束时间，以及已执行工作的详细描述。我们认为这些服务说明在内部非常有价值，因为它们使我们能够及时了解合作伙伴客户站点的情况。如果出现问题，这些记录将为我们提供有关我们多年来遇到的所有先前问题和解决方案的知识。我毫不惭愧地说，我通过找到我几年前忘记为另一个客户写的笔记来解决了一个客户的问题。
关于制作文件的简要警告：在我“以前的工作”（多年前为别人工作）中，公司对一位不付款的客户提起了法律诉讼。我们最终成为不付款客户反诉的对象。我们关于该客户的内部记录和电子邮件被传唤到法庭，并被公开。那次经历让我学到了很多不要将任何您不想公开的内容存储在固定介质中。
我和一些人写了一些电子邮件（呃）选择信中充满了我对这位客户以及公司其他“工程师”的不满。我一点也不喜欢在公开法庭上接受这些事情的盘问。
当我们开始目前的业务时，合作伙伴同意全部固定记录（电子邮件、短信、语音邮件、SVN 存储库中的文件、时间跟踪器中的工作记录等）将始终被视为“面向客户”——即使它们从未打算最终落入客户手中。这很难做到，需要很多纪律，但我认为这是值得的。我们当然希望向客户展示一种专业精神，而践行它就是做到这一点的方法。我绝对不会再像在法庭上那样尴尬了。
答案2
对于您所描述的核心信息（网络图除外），我们使用单个 Excel 工作簿，并将其保存到带有客户名称的网络文件夹中。虽然我能理解为什么人们不喜欢这种方法，但我发现它效果很好，因为它是一个单独的参考文档，我可以随身携带到现场，通过电子邮件发送并快速更新。
我最大的抱怨是缺乏版本控制，但我还没有找到任何可以不让生活变得艰难而运行良好的东西。
为了反驳你的“我追求的是一种比简单的电子表格更便携、更安全、更优雅的流程”：
更便携：什么能比 500 KB 电子表格更便携吗？我害怕使用任何基于云或基于网络的东西，因为无法保证网络连接。
安全：我会给你这个，我也希望能有解决方案让我们的解决方案更安全。
优雅：我们花时间为工作簿创建了一个漂亮的模板。就像我说的，这是一个多页工作簿，而不仅仅是一页散乱的信息。我认为大多数 IT 文档都非常适合表格形式，而电子表格可以使其非常整洁和简单。
虽然我对我们如何记录和存储构建文档有很多疑问，但我真的找不到一个可靠的、格式良好的电子表格的缺点。我还要补充一点，我们与一些大的IT 服务公司也采用类似的工作方式。同样，这很巧妙 - 我来到现场，索要文档，然后得到一个简洁的电子表格，我可以在整个过程中使用它。
答案3
这种可怕的活页夹的最大优点是：
- 非技术客户可以理解它、将其保存在现场并妥善保管，就像他们习惯并已经处理过的各种其他重要文件一样。
- 如果您的客户聘请了替代您的人，他们可以轻松地将其交给您，这是一件专业的事情，当您将他们作为客户时，这会为您提供快速启动和参考。
- 一开始的简单维护日志包含每次现场访问的亮点，是实实在在的东西。
- 该活页夹还保存了带有许可证代码和激活密钥的 CD/DVD 和证书，以备 BSA 或其他供应商访问。
只要你在做了一些有价值的事情后，严格自己更新活页夹，你使用什么数字系统就不再重要了。
当然，如果您几乎所有的支持都是远程完成的，那么活页夹对您来说就完全没用了。
我非常喜欢使用 wiki，因为它易于维护，可以很容易地链接到 ILO 和管理界面，远程桌面和 SSH 登录也很容易。自由格式适合我想要的大多数信息：
站点描述：“网络打印机（OKI 1234 MFP）是约翰办公桌旁边的那台，HP 喷墨打印机型号 0123 位于老板鲍勃的办公室”这使得接听电话变得容易得多：“我们的墨水用完了，我们应该再次订购什么墨盒？”。
每个设备的页面，最好包含图片、类型和配置、用途等。
Wiki 有一些不错的导出模块，可以生成硬拷贝或数字文档，以便移交和包含在可怕的活页夹中
答案4
这可能不是您想要的，但这就是我所做的。
我使用 Microsoft Office 为每位客户创建所有文档。我使用 Excel（IP 地址信息、交换机端口映射、机架布局）、Word（配置信息、发票、SOW 模板）和 Visio（图表）。我创建了一个文件夹层次结构，父文件夹名为 Consulting，子文件夹以每位客户命名。当我创建或更新客户文档时，我会将它们同步到我的 iPhone（使用需要携带的文件)、USB 拇指驱动器和 DropBox 帐户（使用双因素身份验证）。这样，无论身在何处，我都可以访问所有文档（不管怎样）。
我还使用一款名为办公时间。有一个 iPhone 应用程序和一个配套的 Windows 应用程序，因此当我在现场时，我可以通过 iPhone 访问项目信息、发票、工时等，而当我回到家时，则可以将这些内容同步到我的桌面。