关于架构设计文档一些想法

架构设计文档应该体现如下四要素:

  • Logic View(逻辑视图)
  • Physical View(物理视图)
  • Network Structure(网络拓卜图)
  • Workflow/Process Flow(流程图)

每一种图都有自己的画法,并且有比较经典的图,这些图的组合:框框+线条+文字说明

下面用职能图来描述流程图,之前画流程图都是用很简单的黑框框+线条,这样给客户看的话不是很生动,也不能一目了然

总体架构图,也叫接口调用图

架构设计文档还包含着:各种模块,子模块,功能设计,功能点描述。。。。

这种子模块、功能设计或者是功能点描述往往往以点、线为主,以点、线来连成一个面,而面中”娄空“,如下面的样例:

 

做好架构文档的一些建设:

  • 平时自己看到好的可以表达某个意义的图片,存下来,分门别类
  • 看到人家写的好的架构文档,存下来,看看人家是怎么去描述一个功能点的 (我觉得这点很重要,也是快速提高写文档能力)
  • 多搜集一些IT上专用的图标,小图片,logo

猜你喜欢

转载自strongant.iteye.com/blog/2176786
今日推荐