我突然需要全面记录一个中等复杂的平台,并将其分解为服务和应用程序组件,并描述如何迁移这些服务并将其提供给基于云的新平台。
显然,出于简洁的目的和遵守网站规则的需要,我并不想讨论文档的好处和类型,只是想了解管理通用应用程序堆栈的基本“事实”列表。
我初步列出的清单如下。
支持服务
工单
警报
升级
文档
构建文档
服务文档
最终用户文档
安全
配置合规性
包和更新监控
漏洞扫描
备份与恢复
操作系统级
应用程序数据
服务器管理
裸机部署
配置管理
升级和包管理
共享服务
用户身份验证
内部 DNS 和 DHCP
外部 DNS
监控
操作系统级别指标
服务级别指标
外部 URL 监控
报告
Web 分析
可用性报告
操作系统级别统计信息
如果有任何东西缺失,我会很热心地识别它。
附言:我还对使用 Excel 或 Google Docs 模板来跟踪这些项目感兴趣。
答案1
您要记录的事项清单相对完整。
对于格式,我的第一个建议是使其与贵公司的其他文档相匹配(如果您使用 Wiki,请将其放在 Wiki 中。如果您使用 SharePoint,请将其放在 SharePoint 中,等等)——您要确保人们会真正阅读(和更新)文档。
同样,如果您的公司有特定的文档格式,请使用该格式。否则,我的建议是将每个实践领域分成一个单独的文档(备份和恢复;配置和部署;监控和指标;等等……)——使它们成为可以有特定人员负责的逻辑单元。
(请注意,“安全”是一个特殊情况——实施和维护安全系统应该在每本书中都有介绍,而《安全》这本书应该只是推动该实施的一般公司安全政策。这往往是一种更干净/更合理的设置,而不是让每个人都因为需要查找某些东西而争抢安全书。)