如何转需求为开发文档

需求分析与难点

需求分析:
确定新系统的目的、范围、定义和功能时所要做的所有工作。难点在于把握客户真实需求,往往需求方提出的只是表象,而不是真实需求的本质,研发部门要让开发工作变得容易,必须把握住表象之下的软件/程序设计相关的本质。

主要目的

主要目的:
让项目实现的功能/过程是可预见的。企业级项目开发,需要在敲代码前进行需求分析、总体设计、详细设计。在设计的过程中会发现最初需求/实现流程/技术栈等要求不合理的地方,越早地发现不合理的地方纠错成本越低。

编码前的(至少)三个会议

编码前至少三个评审会议:
做不做(技术、人员、经济、法律等各方面是否允许)
怎么做(需求、原型、设计、架构等)
谁来做(人员、工期、迭代周期等)
今天王小姐来开会,提出了一些要求,她需要的网站是什么样,下面的是王小姐的大致原话:


我们要做一个在线购物系统销售月饼、嫦娥吴刚神话书籍以及月兔等周边玩偶。顾客第一次访问网站,主页将显示一些特色产品、分类列表,还要有搜索框供顾客搜索。顶部要有一个导航条。产品列表中要包含产品缩略图,产品名称,点击它可以进入产品详情页面。一个产品可以属于多个分类。还要有个页面让我们自己添加新的产品类别和相关产品,但是只有店长才能使用这个功能,普通员工是不允许的。网站上线之后,要使顾客能够通过搜索引擎搜索到我们的网站。产品可以被添加到一个购物车。订单结算页面是单独的,这个页面向顾客展示当次购物结算信息以及让顾客提交订单给我们,还可以使用支付宝在线付款。要保证顾客信息、订单信息等数据的存储安全,不能被黑客拿去了。还需要对网站交易进行分析,需要知道哪些人,在哪些地方,买了哪种东西,方便我们做更有效的推荐商品。还要知道订单的转化率。当订单提交以后,顾客可以查看订单的处理状态,比如是“已提交”,“正在处理产品”,“已发货”,“已完成”等等。顾客也可能退货,退货时需要把钱退给顾客,以及我们会扣一部分手续费,让顾客能方便地看到我们的退货政策。本购物系统需求清单:...

然后对其话进行翻译成开发文档:

  1. 本购物系统需求清单:
  2. 多种产品的销售(通用的产品模型)
  3. 产品分类模型
  4. 特殊产品的处理
  5. 产品搜索
  6. 导航条
  7. 产品列表页面
  8. 产品详情页面
  9. 产品类别及产品的管理(增、删、改、查 CRUD )
  10. 权限管理
  11. SEO,搜索引擎优化(生成站点地图)
  12. 购物车模块
  13. 订单结算页面
  14. 订单结算系统
  15. 在线支付模块
  16. 系统网络安全(尽量避免bug,以及不能出现XSS之类的漏洞)
  17. 订单数据统计(分析)
  18. 订单状态跟踪
  19. 退货、退款
  20. 信息发布与管理(CMS)

大型项目必要文档:

总体设计:项目架构、技术选型、系统模型等说明文档
项目管理:需求分析、预算、风险、人员安排、进度计划 等
使用文档:项目运行的必要信息、步骤、系统环境等
需求文档:定义项目应该做什么
详细设计:定义项目应该怎么做
支持文档:面向技术支持团队的培训资料,问题解决方案
用户文档:使用说明书,接口指南等

小型项目文档应有内容:

概述项目的作用,要解决的问题
项目采用的分发许可证
使用例子(quick start)
安装指南
指向社区支持、邮件列表、论坛的链接
指向bug跟踪、问题反馈、代码提交的链接
源码链接

Sphinx & reStructuredText
Sphinx是一个文档生成工具,采用reStructuredText语法格式。

Markdown
Markdown 语法说明 (简体中文版)
Mastering Markdown

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

推荐阅读更多精彩内容