熟悉了软件架构师的定位和职责后,那么如何设计一份架构文档呢
有哪些常用的步骤和评判标准呢
一:文档编写流程
不同领域对应的架构文档的格式可能有些不同,但都应该有以下步骤
1 对外的关系
1.1 系统范围
1.2 系统对外接口描述
1.3 系统对外业务流程
2 内部拆分及子系统之间关系
2.1 真题架构风格选择
2.2 找出关键需求提取关键属性来指导决策。
2.3 差分子系统
3 风险子系统或关键子系统详细设计
3.1 子系统架构风格选择
3.2 子系统关键算法或流程
3.3 子系统关键类图关系
二:评判标准
1 对外的关系的设计:
关系是否清晰,
逻辑是否自洽。
2 内部子系统的关系的设计:
各个子系统业务边界是否清晰(低耦合),对外接口是否够简单明了,是否体现了自身的业务需求(甚至无需配备说明文档就能够供外部调用)
各个子系统内部是否是否够紧凑(高内聚),团队内部协作够顺畅,代码提交是否经常冲突
3 能否区分核心子系统和周边子系统,及核心子系统对外关系是否够简洁。
3 业务功能模块和内部子系统之间的映射关系是否融洽,合理:
以下是一个关系转化的例子: