前言
大家好我是西南张家辉,最近负责了一些做基建和标准化的专项。顶峰时,周产 30 篇文档;不小心从 coder,变成了 writer;
今天主要介绍的不是怎么写文档,只是想分享一下怎么更好的用 图 表达,结构化的表达很重要,我把图 的表达看做代码中的 设计模式 来类比,文字中的 设计模式(Design pattern) 可以是小学语文中的起承转折,也可以是霸道总裁文的套路,也可以是图的不同表达。
工具
一图胜千言,别 bb 直接上图,今天分享一下自己码字作图的一些收获,其中主要使用 processOn 和 Xmind,语雀等工具;主要介绍了四种图思维导图(树状图)、鱼骨图、泳道图、UML的实践。
使用&目的
开发前期的流程设计,业务梳理和理解,转正答辩,升官加薪必备;
程序员不仅仅只是写代码,思考和设计流程和结构更为重要,这是从初级到中高级的必备之路;
最佳实践(造火箭项目🚀)
北京时间(2021.9.16)今天上午8点02分,佛罗里达州肯尼迪航天中心,SpaceX的猎鹰9号火箭搭载龙飞船发射升空;蹭个热点,我们来看看在造火箭项目中怎么用图表达各个流程。
那么作为一个软件工程师在一个火箭🚀项目中占据怎样的角色,宏观的视角怎么看,怎么在部门之间协作,从宏观到围观视角?
部门组织架构树状图
组织架构图-树状图作为 CEO 的 Musk 同学要梳理一下组织架构
-
文字版本:我们有 CEO&CTO(Elon Musk),董事(Antonio Gracias), 董事(don harrison),CEO 下面分管 CFO...
-
图(父子关系,结构化,上下管理可以用树状图)-- 语雀思维导图:
造火箭项目倒排鱼骨图
需求:研发部门要造火箭(确真),整体项目节奏安排,需要倒排一下时间,项目 PM 开始工作
- 文字:项目启动,造火箭,火箭部署,火箭发射,项目收尾,具体节奏 balabala...
- 图:鱼骨图 ProcessOn:
研发流程泳道图
需求:现在项目的倒排开始,你们部门接到了要开发火箭体系系统管理中心的需求,软件工程师 James 在其中一环,咋们怎么才能合理的梳理出和各个部门协作
-
文字:需求阶段、设计阶段、开发阶段、联调/测试阶段、预发/上线发布,和产品,设计,测试,前后端配合......
-
图:(泳道图,团队协作,事件推进可用)-- ProcessOn 泳道图
泳道图,一种UML活动图,能够清晰体现出某个动作发生在哪个部门
一个小需求:用户信息查询UML
需求:前端 Brendan 被分配到一个用户权限查询的需求,不同页面权限不同,想知道前后端服务是怎么协作的流程?
- 文字:用户进入登录界面 > 输入密码 > 服务中心查询信息 > 向权限模块咨询是否有权限 > 有权限返回对应权限信息 > 返回用户界面,提示登录成功。
- 图(页面逻辑细节,展示不同事物之间的传导,用UML)ProcessOn UML:
什么时候用?
| 图标 | 什么时候用 | 实践 |
|---|---|---|
| 树状图 | 组织架构,分类 | 部门组织架构,项目组织架构,产品分析SpaceX 组织架构 |
| 鱼骨图 | 时间序列,线程进行 | 项目倒排,活动时间安排造火箭🚀 时间倒排 |
| 泳道图 | 流程推进,部门协作 | 研发部门协作,研发流程进行研发部门协作 |
| UML | 软件结构设计,产品设计 | 需求分析,软件流程设计权限登录设计 |