咨询:为客户组织网站/环境文档？

Question

随着时间的推移，我开始为不同的客户进行咨询和合同工程工作。最近，客户要求获得某些类型的文档。

• 我们正在安装的新网络时钟可以使用哪些静态IP地址？
• 如何在网页过滤器中添加排除项？首席执行官不能再去NRA网站了！！
• 我们需要关闭Linux服务器，因为有计划的停电。再说一遍命令是什么？

这些都是小企业，通常没有专门的技术人员。在单个公司中，Wiki/Confluence/Sharepoint等作为文档和环境信息的中心存储库都是有意义的，但我很难找到一种一致的方法将这些信息交付给离散的客户。

我正在寻找一个比简单的电子表格或可怕的未定义更可移植、更安全和更优雅的过程。

• 重要IP地址、DHCP范围等。
• 网络图(如果需要)。
• 管理用户名、密码和管理URL。
• 软件许可密钥。
• 支持合同和保修信息。
• 供应商支持联系人和指示。

我知道这里还有其他顾问。对于在多个环境中以客户友好的格式维护文档，有什么建议或建议吗？你是怎么做到的？

Answer 1

对于您所描述的核心信息(网络图除外)，我们使用单个Excel工作簿，并将其保存到具有客户名称的网络文件夹中。虽然我能理解为什么人们不喜欢这种方法，但我发现它很好，因为它是一个参考文档，我可以随身携带到网站，电子邮件，并迅速更新。

我最大的抱怨可能是缺乏版本控制，但我还没有找到任何能正常工作而不让生活变得艰难的东西。

为了反驳你的“我在拍摄一个比简单的电子表格更便携、安全和优雅的过程”：

更便携:有什么可以比500 be的电子表格更便携？我会害怕使用任何基于云或网络的东西，因为互联网的连通性无法保证。

有保障:这个我会给你，我也希望解决办法，使我们的解决方案更安全。

优雅:我们花时间为我们的工作簿创建了一个很好的模板。就像我说的，这是一本多页的工作簿，而不仅仅是一页散乱的信息。我认为大多数IT文档都非常适合于表格形式，而电子表格则保持了这一点的简洁性。

虽然我在如何记录和存储构建文档方面有很多问题，但我确实无法在一个可靠的、格式良好的电子表格中找到错误。我还要补充的是，我们与一些大型IT服务公司合作，他们的工作方式与之大同小异。再次，它是辉煌的-我出现在网站，要求文档，并得到一个整洁的电子表格，我可以使用的期限。

Answer 2

那个可怕的活页夹的最大优点是：

• 非技术客户可以理解它，将它保存在现场，并保持它的安全，就像他们习惯并已经处理各种重要的文书工作一样。
• 你的客户可以很容易地把它交出来，以防他们为你雇一个替代者，这是一件需要你做的专业的事情，而且当你把他们作为客户时，这会给你一个快速的开始和参考。
• 一个简单的维护日志在一开始与每一次访问的重点是有形的东西。
• 该活页夹还持有CD/DVD和带有许可证代码和激活密钥的证书，以防BSA或其他供应商访问。

不管你使用什么数字系统，只要你在做了有价值的事情时，就要求自己更新活页夹，这一点就不再重要了。

当然，如果你远程提供几乎所有的支持，那么这个活页夹对你来说是完全无用的。

我一直很喜欢使用wiki，因为它很容易维护，超链接到国际劳工组织和管理界面，远程桌面和SSH登录是很容易遵循的。自由格式最适合我想要的信息：

• 网站描述：“网络打印机(OKI 1234 MFP)是约翰办公桌旁边的一台，惠普( HP )喷墨打印机型号0123位于老板办公室的波布斯( Bobs )，”这样接电话就容易多了：“墨水用完了，我们应该再订购什么墨盒？”
• 页面为每个设备，理想的图片，类型和配置，它的目的等。
• Wiki有一些不错的导出模块，可以生成硬拷贝或数字文档，用于切换，并包含在该可怕的活页夹中。

Answer 3

我同意Dan关于Excel是一个好的、可移植的解决方案的观点，我认为他为它提供了一个很好的理由，除了安全部分，我认为担心有些误导：

不管你想用什么方法分发，都可以包括一个安全的解决方案(例如加密的电子邮件、安全的共享存储等等)。版本控制(例如影子副本、svn等)也是如此。

然而，作为建设性的批评和尊重，我想补充一点，共享Excel电子表格的一个主要缺点是它的并发性限制。当您有两个或更多管理员时，他们会发现被迫选择一次只能打开一个工作表进行编辑，或者保存多个副本，然后需要合并(哪些数据是最新的，哪些不是最新的？)。这真的很痛苦。

一个更好的解决方案是使用Excel (或您想要的任何东西)作为选择的小型数据库的前端，无论是访问(仅仅是为了解决可移植性)、MS、MariaDB还是任何您喜欢的东西。

我主张将此作为一种解决方案，它不仅适合于将信息传递给另一方(=Excel)，而且也适合于维护正在进行的文档工作。

简单地说，我的观点是，即使只有几个管理员(更不用说更大的商店)，依赖Excel进行文档数据存储的部门也是一个拥有大量文档的部门。从来没有见过异常，除非只有一个管理员。

但是，使用数据库驱动存储的部门有机会保持紧凑的、最新的文档。因此，这只是一个努力的问题。Excel是一种可行的数据库前端，有利有弊，但绝不是唯一的选择。