对于希望不断取得进步的人要是身边有个良师益友是最好不过,但这种条件可遇而不可求;如果没有这种条件,不断总结自己的经验和教训也是一种取得进步的方法。离开工作岗位已经快2个月了,回顾一下之前写系统设计文档时候的一些写作大纲,也许以后还用得着吧
1, 系统概述
介绍系统的应用背景和作用,说明为什么需要该系统,突出系统的价值和重要性
2,系统
介绍系统在整个网络中的位置和该系统与周边网元/部件的接口关系
3,系统结构
介绍系统的内部模块划分,各模块的定位和作用
介绍系统的主要数据模型
介绍系统的进程/线程运行模型
4,系统部署
介绍系统的各个模块是如何在服务器之间进行分配和部署的(1:1, 1:N,N:M等等)
5,主要业务流程
通过主要业务流程的实现,将系统各个模块的关系串起来,检验系统设计的合理性
6,系统软硬件环境
介绍系统运行的软硬件环境要求,例如操作系统,数据库,JDK的版本要求等
介绍系统运行对周边网元环境的要求
7,设计约束
介绍在该系统设计中存在哪些限制和约束
8,设计指标
基于以上设计和约束,定义系统需要达到的关键设计指标(质量,性能等方面),作为后续开发,测试,验收的设计依据
9,设计参考
另外,对于系统的重要设计需要详细描述的建议另用专项设计文档,例如系统性能设计,可靠性设计,可维护性设计等