如何清晰地描述一个项目架构

工作中我们经常需要给其他人介绍项目架构,有什么方法可以提高介绍的效果吗?根据本人经验,总结了一篇指南。

要让对方掌握项目架构,一个清晰的介绍架构和顺序可以事半功倍。

项目背景

在介绍项目架构之前,首先要介绍一下项目本身的意义和目的,便于对方了解项目背景

  • 解决了什么问题,满足了什么需求等?
  • 目标用户是谁?(可以用类似讲故事的方式介绍对目标用户的带来的价值)
  • 目前用户的使用情况如何(访问量,满意度,各个功能使用情况等数据)

功能点

项目针对用户需求或问题,开发了哪些功能

在介绍功能的时候,最好要有用户视角,而且可能还涉及到多个不同角色的用户。比如ToB的终端用户,B端企业用户,企业老板等

核心功能

满足用户核心需求、解决核心问题的功能

比如:

  • RPC框架中的远程调用
  • ORM框架中对象关系转换
  • 智能问答系统中问答功能

辅助功能

配合核心功能工作的辅助功能

比如:

  • RPC框架中的调用链路跟踪、监控、连接池管理、负载均衡等
  • ORM框架中的动态SQL、参数绑定、缓存等
  • 智能问答系统中的知识库管理、相似问题学习等

性能&安全

在比较完善的系统规划中,性能&安全都是重要功能特性之一,可以作为广义功能来介绍

比如:

  • 吞吐量
  • 响应时间
  • XSS/CSRF/SQL注入等漏洞修复
  • 数据安全等

这一部分也可以放在架构之后再介绍

发展规划

如果有的话,就简单介绍一下项目未来的发展方向(不要超过一张PPT,不要超过1分钟)


架构图

使用各种类型的图表、文字、动画等把项目的整体架构描述清楚,外行觉得很思路清晰,内行能够很容易掌握技术点,能够理解架构的优缺点。

优缺点是指架构设计中的取舍,取对项目重要的特性,舍弃本项目影响不大,可以接受的特性

模块层次图

系统中各个模块的组成,模块实现方式,模块层次,模块之间调用方式等

比如:存储模块、缓存模块、日志模块、运营数据、监控模块以及各个业务功能模块。

核心流程图

各个模块在核心功能及主要辅助功能流程中的作用,使用流程图把各个模块串联起来

使用流程图形式,让对方了解系统是如何使用各个模块协作实现核心功能

技术点

流程在使用各个模块中实现的技术点

比如:

  • 缓存及缓存同步
  • 分布式锁
  • 分布式会话管理
  • 负载均衡
  • 监控
  • AB Test
  • AOP或字节码修改等

如果有技术亮点,可以重点介绍一下

遗留的问题

没有一种架构是完美的,根据业务发展情况,有的问题的优先级不高,可以暂时保留

  • 比如缓存同步的方案、缓存数据量太大、运营数据比较杂乱等

改进方向

如何解决遗留的问题,如何更好满足未来的需求,当业务量不断增大的时候,是否有预案

比如:

  • 分库分表、异构数据库等
  • Set化
  • 数据冷热分离等

监控&告警

没有接入监控&告警系统的项目是不允许发布上线的

  • 项目使用了什么监控系统,监控了哪些指标,使用什么样的告警机制

高可用

如果是行业标准高可用方案的话,简单介绍一下即可


其他

  • 与其他类似项目的对比
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,706评论 4 366
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,002评论 1 301
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,462评论 0 250
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,375评论 0 216
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,763评论 3 294
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,849评论 1 224
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,033评论 2 317
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,768评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,490评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,734评论 2 253
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,204评论 1 264
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,566评论 3 260
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,227评论 3 241
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,137评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,934评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,926评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,774评论 2 274

推荐阅读更多精彩内容

  • 关于Mongodb的全面总结 MongoDB的内部构造《MongoDB The Definitive Guide》...
    中v中阅读 31,794评论 2 89
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 11,631评论 4 59
  • 数据结构队列集合链表、数组字典、关联数组栈树二叉树完全二叉树平衡二叉树二叉查找树(BST)红黑树B-,B+,B*树...
    jackcooper阅读 3,251评论 1 50
  • 001 紧张 离开了原来的品牌,到了一个新的环境,对所有的一切都很陌生,有些不知所措!开始跟着老员工一点一点的学习...
    福利福利阅读 187评论 1 3
  • 今天是周六,女儿不用上学,她要求和我一同去逛菜市场,我答应了。 :“谁在唱歌?那么悲伤。”女儿嚷起来。顺着歌声望去...
    王梓烨妈妈阅读 182评论 0 0