用思维导图的方式来描述整个项目
前言
我在浏览项目时发现一篇文章《开源项目spring-shiro-training思维导图,让项目不再难懂》,关于项目总结写的很好,我借此改进并整理成我自己的惯用方式,也借此希望能带给大家一些启发。
改进的目的
主要是原楼主的导图过于冗长,不适合略读,同时也不符合我自身的习惯。
我自己的导图结构
- 项目简介:主要描述项目的信息
- 安装使用:用于一些入门性的指导
- 架构:一般项目开发都会有架构图,直接贴一张架构图,美观便捷
- 业务模块及功能:直接贴上模块功能图,很方便
- 主要技术:分前端、后端展开描述
- 项目代码结构解析:主要也是描述每个代码包的作用,一张截图说明
- 难点补充:主要针对一些遗漏的问题展开描述,没有则略过