我正在 MS Word 中创建这个文件,以创建一个带有标签的 3 环活页夹,其中包含有关我们的 Web 服务器的所有文档。
我应该包括哪些主要类别?
我们有 2 台服务器,都是 Windows,1 台用于 Web,1 台用于 SQL Server,其中 Web 1 运行 iis7 和 coldfusion。
我没有接受过系统管理员培训,只是学到了一些知识。例如,我宁愿拥有更多信息,也不愿没有信息,例如当我们刚刚迁移服务器时,我们错过了很多东西,因为没有文档。
所以我想把工作做得彻底一点?我不介意把它当成 wiki,但我的老板和同事对 wiki 和如何使用 wiki 不太熟悉。我倾向于成为我们团队中比较严谨的人,想要把所有事情都记录下来。
有什么建议么?
答案1
在某种程度上,你包含的内容很大程度上取决于WHO你正在为谁编写文档。你是为管理员编写文档?为用户?为程序员?还是以上所有的人?就像你在设计网站时一样,你需要查看用例并解决它们。
作为一名程序员和/或系统管理员,我认为提供给我的文档中至关重要的事情:
- 如何创建备份
- 如何恢复备份
- 如何从头开始建立网站(所需软件、安装过程、配置等)
- 依赖项列表(需要 CF、SQL Server、x 需要)
- 正在使用的任何 API 的文档
- 原始需求文件、变更文件(如果存在)
- 关于如何创建/使用管理的信息
- 用户离开时更改访问权限的流程(撤销用户访问权限、更改共享密码等)
- 任何用户/客户/流程特定的定制
- 任何“陷阱”场景
- 任何现有的用户文档
- 计划任务及其时间表
- 作为维护的一部分,需要定期运行的进程(索引更新、碎片整理等)
如果你正在创建一个电子资源,比如 wiki,那么最好有以下这些:
- 原始样图和模型
- 图片来源
- flash .fla 文件
- 从现有站点到需求/变更文档的链接
- 发布代码的当前副本,其日期/版本/等随每次主要发布或按照时间表(如每月)进行更新。
答案2
使用 OneNote 代替 Word 来记录文档
- 多个用户可以同时使用
- 如果需要,可以导出为 pdf
- 右键单击“发送到 OneNote”功能增加了我们文档的价值。
- 追踪编辑
这些只是部分功能。对我们来说,好处实在太多,无法一一列举。