不同项目在使用该模板时多少会有出入,应以项目实际情况作为依据。
(该文档可以 .md 格式存放于项目根目录,或编写到readme 中)
项目描述
涉及如下方面
- 项目背景 (可引用项目立项书)
- 项目需求 (可引用产品文档,需求说明书,任务矩阵,UI 设计图,等)
- 所用技术栈 (框架设计模式,语言或跨平台技术解决方案)
工程地址
git 或 svn 地址
框架图示
主要介绍架构分层,moduel 模块间依赖情况 (根据不同的框架设计模式而定,下图举例MVVM 组件化框架图示)
示例1
示例2
模块介绍
(下面以模块化框架为例,介绍各模块用途, 包含module 工程结构图,核心类加以说明)
app:
app壳 工程,是依赖所有组件的壳,该模块不应该包含任何代码,它只作为一个空壳存在&