详细设计模板:

本模板来自Github Gist

XXX详细设计

概述

目的

本文档是针对XXX系统给出的系统详细设计文档,在本文档中,将给出XXX系统的系统模块列表,各模块的功能、输入、输出、逻辑流程与错误处理,以及各用户界面的详细流程等内容。

XXX系统的系统详细设计与实现基于XXX系统的概要设计,在其原则与基础上进行细化与划分,以为下一步的系统实现打下基础。

本文档的适用读者为XXX系统的产品经理、设计人员、开发人员、测试人员以及后续维护人员。

设计约束

例如应该遵循什么实现的原则,比如源码目录结构、简单的编码规则,每个源码文件应该包含什么版权申明,是否要做单元测试,是否采用CMake或者Makefile或者gcc/clang等构建工具等。

术语说明

如:

  • SSOOS:Security Subsystem Of Operating System,操作系统安全子系统

参考资料

如:

  • 沈晴霓,卿斯汉 操作系统安全设计 机械工业出版社 2013年9月

系统模块设计

在这里需要给出一个大图,或者文字说明本系统中所包含的所有子系统或者模块,以及本系统与哪些外部系统需要进行交互(编译和运行时都依赖于哪些软硬件,包括具体的版本)。 这里的图需要表现的是静态结构,用自己熟悉的工具做图, 图的内容可以是:

  • 整体系统结构
  • 分层图,也就是类似多层架构设计的图

关键结构的也可以使用表格来描述, 如:

| 成员名称 | 说明 | |----------+------| | XXX | XXXX |

模块 A 设计

模块 B 设计

全局数据结构设计

人机交互设计