随着时间的推移，我为各种客户承担了咨询和合同工程工作。最近，客户要求提供某些类型的文档。
这些是小型企业，通常没有专门的技术人员。在一家公司内，Wiki/Confluence/Sharepoint 等都可以作为文档和环境信息的中央存储库，但我很难找到一种一致的方法来将这些信息提供给离散的客户。
我正在寻找一种比简单的电子表格或充满过时信息的可怕的活页夹更便携、更安全和更优雅的流程。
我知道这里还有其他顾问。关于以客户友好的格式在多个环境中维护文档的任何建议或技巧？如何你做呢？
Eva*_*son 12
自 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 位置/联系信息）。
我对在文本文件、维基等内容中存储自由格式信息的想法持相当否定的态度。结构有助于良好的搜索。每当我可以获得结构化存储机制来为我工作时（即使这意味着我必须编写软件来查询它），我更喜欢它。我可以从配置文件、数据库等中解析出来的评论，当遇到几乎立即过时的手动生成的文档时，总是能赢得我的支持。
当我们必须存储“自由格式”信息时，我们使用我们自己的 SVN 存储库。它包含我们多年来创建的所有各种零碎的静态文档，由客户归档。自 2004 年以来，我们一直在为此使用 SVN，它作为我们的协作工具运行得非常好。我们对数据库架构、系统管理脚本、组策略对象备份等进行版本控制。我尝试将所有可以检查的内容纳入版本控制。
使用基于文件系统的索引工具搜索我的结帐非常容易。我知道我们每个人都至少有一个完整的存储库副本可供我们随时在本地使用。我们还通过 SSL 上的经过身份验证的 WebDAV 访问存储库，以防万一我们必须访问存储在那里的数据并且只有浏览器访问权限。
我们从未被要求这样做，但我们很乐意在 SVN 服务器上创建一个帐户，以允许客户签出并与他们自己的文件进行交互（如果他们有如此倾向的内部资源） ）。我们使用标准化的格式来存储所有静态客户文档（软件许可文档、购买记录等），这是不言自明的。
除了 SVN 存储库，我们还自托管我们的电子邮件。自从公司的域开始接收电子邮件以来，所有传入/传出的电子邮件都已存档。它可以作为 BSMTP 日志提供给合作伙伴以供参考（而且，就我个人而言，我发现它非常宝贵）。这种情况从未出现过，但我知道，如果客户提出要求，我们很乐意让他们访问与员工之间的任何通信日志。提供合作伙伴之间的内部通信将更加困难，因为我们很可能在同一消息中引用多个客户。（我们可能应该在这方面做得更好，但我们还没有。）
密码是我们流程中的主要“疣”。我们为每个客户使用单独的“密码安全”存储库（具有独特的组合），以允许与客户共享安全文件。我们将所有安全文件的主密码保存在另一个安全文件中，组合只有合作伙伴知道。这部分确实需要一些工作。我认为我们希望每个客户都使用真正的多用户密码保险库应用程序（带有审计跟踪等）托管一个现场凭证保险库，但我们已经将这个想法推向了海滩近 10 年.
我们的时间跟踪记录非常详细，并以客户想要的任何电子格式（到目前为止，都是 ASCII 文本和 PDF）提供给客户。客户获得每个可计费事件的开始/停止时间，以及对所执行工作的详细描述。我们认为这些服务说明在内部非常有价值，因为它们使我们能够及时了解合作伙伴客户站点中发生的情况。如果出现问题，这些记录可以让我们了解多年来遇到的所有先前问题和解决方案。我并不羞于说我已经通过查找我几年前忘记为另一位客户写的笔记解决了一位客户的问题。
一个快速而谨慎的旁白：制作文件：在我的“旧工作”（几年前为其他人工作）中，公司对一位不付款的客户提起了法律诉讼。我们最终成为了来自未付费客户的反诉讼的业务端。我们的内部记录和电子邮件回复：该客户被传唤并在法庭上裸露。那次经历教会了我很多关于不要将任何内容存储在您不想公开的固定媒体中的知识。
我写了一些电子邮件，其中包含一些（erm）选择词和短语，讲述我对这位客户以及我公司的其他一些“工程师”的不满。不得不在公开场合对这些事情进行盘问并不是我喜欢的事情。
当我们开始我们目前的业务时，合作伙伴同意所有固定记录（电子邮件、短信、语音邮件、SVN 存储库中的文件、时间跟踪器中的工作记录等）将始终被视为“面向客户”——甚至如果他们从未打算最终落入客户手中。这很难做到，需要很多纪律，但我认为这是值得的。我们当然希望向我们的客户展示专业精神，而生活就是这样做的方式。我当然永远不会再像在那个法庭上那样尴尬了。
