我即将创建一个站点圣经，即我们的 Web 服务器的文档？

Question

我正在 ms word 中创建它，以创建一个带有标签的 3 环活页夹，其中包含有关我们 Web 服务器的所有文档。

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

我们有2台服务器，都是windows，1台用于web，1台用于sql server，web 1，运行iis7和coldfusion。

我没有受过系统管理员的培训，只是我学到的东西。比如我宁愿有更多的信息而不是没有信息，例如我们刚迁移服务器时，我们错过了很多事情，因为没有文档。

所以我想做一个彻底的工作？我不介意这是一个 wiki，但我的老板和同事对 wiki 和如何使用 em 不太熟悉。我倾向于成为我们小组中的肛门者，想要点所有的 i 并记录所有内容。

有什么建议？

Answer 1

在某种程度上，您包含的内容在很大程度上取决于您为谁提供文件。您是否在为管理员记录文件？对于用户？对于程序员？上述所有的？就像设计网站时一样，您需要查看用例并解决它们。

我认为对于作为程序员和/或系统管理员提供给我的文档至关重要的事情：

• 如何创建备份
• 应如何恢复备份
• 如何从头开始设置站点（所需软件、安装过程、配置等）
• 依赖项列表（需要 CF、SQL Server，x 需要）
• 正在使用的任何 API 的文档
• 原始需求文件、变更文件（如果存在）
• 关于如何创建/使用管理的信息
• 用户离开时更改访问权限的过程（撤销用户访问权限、更改共享密码等）
• 任何用户/客户端/流程特定的自定义
• 任何“陷阱”场景
• 任何现有的用户文档
• 计划任务及其时间表
• 作为维护的一部分，需要定期运行的进程（索引更新、碎片整理等）

如果您正在创建电子资源，例如 wiki，那么最好拥有：

• 原始组合和模型
• 图片来源
• 闪存 .fla 文件
• 从现有站点到需求/变更文件的链接
• 发布代码的当前副本，带有日期/版本/等。随着每个主要版本或按时间安排（如每月）更新。