我负责build立和pipe理一个全新的实验室环境,由许多不同angular色的机器组成。 有一个VM主机,几个Web服务器,几个数据库服务器,等等。
有一些非常特殊的需求和stream程需要logging在本实验室环境中,例如我们不希望自动启动Windows更新,我们想要捕捉很多想法来向多个不同方面解释高pipe,经理,开发人员,IT经理,质量保证人员)。
所以,当我在做这个设置的时候,我真的想要用某种forms的文档捕捉这些对话。 我正打算继续创build一个Word .doc,用几个不连续的部分组织每个服务器angular色:
我想知道的是,如果在为这些机器创build文档时可以使用更好的模板。 我希望无论我最终创build的是否足够好,以便别人重build机器,如果需要的话。
一个好的文档系统最重要的是:
我试过单词文件。 他们完全失败了3分。 Word文档很难更新,最终会有不同的副本等。
我find的最好的系统是维基。 DokuWiki适合我的目的。 我可以从任何地方轻松访问和更新它。
我有我的维基页面描述整个networking设置,链接到每个服务器,群集和应用程序的页面。 通过这种方式,关于特定项目的所有细节都保存在单独的页面上,并且可以从与其相关的每个地方链接到 – 当发生变化时,我只需要在一个页面上进行更改,并且可以轻松地find我正在寻找的信息对于。
它还允许你指定命名空间模板,所以当我创build一个新的服务器页面时,它会预先填充表格来inputIP地址,硬件configuration等等。所有的空字段都有FIXME,所以我可以search整个wiki对于FIXME并查看文档中缺less的内容。
如果你真的想看到,你可以编写插件,像configuration文件,parsing它们,并以易于阅读的格式显示它们。 例如,我写了一个名为PatchPanel的插件,它接受networking配线板的文本描述,并为每个端口所在的位置绘制带有标签的图片。
http://blog.emsley.ca/2014/04/documentation.html有一个我如何设置(免责声明:链接到我的博客,完全在主题虽然)更完整的书面。