我即将创build一个网站圣经又名我们的Web服务器的文档?

我用这个词来创build这个文件,创build一个带有制表符的三环活页夹,里面充满了关于我们web服务器的所有信息。

我应该包括哪些主要类别?

我们有2台服务器,两个窗口,1个网页,1个SQL服务器,networking1,运行iis7和ColdFusion。

我没有作为系统pipe理员的培训,只是我学到的东西。 比如我宁愿有更多的信息,也没有信息,比如我们刚刚迁移了我们的服务器,而且我们错过了很多东西,因为没有文档

所以我想做一个彻底的工作? 我不介意把它当成一个wiki,但是我的老板和同事对维基不熟悉,以及如何使用它们。 我倾向于成为我们小组中的肛门分子,想要把所有的我都打成一团,并把所有的事情都logging下来。

有什么build议么?

在某种程度上,您所包含的内容将取决于您要logging的人数。 你loggingpipe理员? 对于用户? 对于程序员? 上述所有的? 就像在devise网站时一样,您需要查看用例并解决它们。

对于作为程序员和/或系统pipe理员提供给我的文档,我认为这些文档至关重要:

  • 如何创build备份
  • 应该如何恢复备份
  • 如何从头开始设置网站(所需的软件,安装过程,configuration等)
  • 依赖关系列表(需要CF,SQL Server,需要x)
  • 使用任何API的文档
  • 原始需求文档,更改文档(如果存在)
  • 有关如何创build/使用pipe理的信息
  • 当用户离开(撤销用户访问,更改共享密码等)时更改访问的过程。
  • 任何用户/客户端/进程特定的定制
  • 任何“疑难杂症”情况
  • 任何现有的用户文档
  • 计划的任务和他们的时间表
  • 需要定期运行的进程(索引更新,碎片整理等)作为维护的一部分

如果你正在创build一个电子资源,比如维基,那么这样做会很好:

  • 原始的比赛和模型
  • 图片来源
  • 闪光.fla文件
  • 从现有网站链接到需求/更改文档
  • 发布代码的当前版本,date/版本等。 每个主要版本或按计划进度更新(如每月更新)。

使用OneNote而不是Word文档

  • 多个用户可以同时使用它
  • 如果需要,导出到PDF
  • 右键单击“发送到onenote”function增加了我们文档的价值。
  • 跟踪编辑

这些只是一些function。 对我们来说,实际上有太多好处要列出。