Questions tagged «documentation»

3
如何避免服务器文档与实际设置不同步?
我们拥有适用于我们环境的相当不错的文档(采用AsciiDoc格式),该文档最近允许另一个人在30分钟内从头开始重新创建整个设置。 但是,我注意到在初始设置后,很容易发生对系统进行小的更改(例如:inetd被禁用,我的IMAP服务器在另一个端口上监听ManageSieve连接,新的路由器被添加到exim配置中)不会立即出现在文档中(如果有的话)。 我的想法是通过(部分地)从配置文件和其中的注释中生成文档来避免此问题-一种实现此方法的方法可能是将/etc其/usr/local/etc放入某些源代码管理系统(例如git),然后运行该脚本可在每次提交时重新生成文档。但是,我不确定这是否会过大和/或太难解决(毕竟,我不想要文档中源文件的完整副本,而只是差异)。 其他人如何避免服务器文档过时-是否有一种很好的方法可以使它们自动保持同步,或者您只是有纪律在修改系统的同时更新文档?

7
您希望开发人员提供什么级别的文档?
已锁定。该问题及其答案被锁定,因为该问题是题外话,但具有历史意义。它目前不接受新的答案或互动。 标题确实说明了一切。 有时最终可能会导致开发和IT在这类事情上处于僵局。当您期望安装,修补,维护,启动,停止和诊断在一个或多个服务器上运行的解决方案时,您期望什么级别的文档?
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.