软件工程和UML里面对文档有具体详尽的要求,开发中往往很难按部就班,但是文档的必要性不言而喻:统一目标,确定规范,提升效率和质量等等;以下都是本人的文档写法,非权威表述,欢迎指正!
一 概述
项目动机、原始需求
项目目标
针对客户人群
可行性分析(机会与优势)
二 功能结构
要实现什么功能
技术方案选择(B/s、C/s、架构层次、手机端兼容、开发框架)
三 核心流程
核心流程图
四 页面结构
产品原型定义(提供美工前端细化需求)
页面结构图
五 数据结构
ER图
数据字典
六 接口通信
涉及到的接口、安全鉴权协议、用户持久化方案
七 开发约定和注意事项
劣势与挑战
开发平台、开发语言、与开发团队要求,项目开发约定
技术要点说明
遗留问题讨论