产品开发技术文档模板

        产品的生命周期一般会经过规划,开发,测试,发布,验收,维护 6个阶段,是产品都有寿命,即使是软件产品,但为了讨个吉利,我不愿意把下线列入产品的生命周期里。

       产品规划更多的来自于产品经理,他们会识别机会,挖掘及探索用户需求,把他们转变为可行且有一定市场的方案,并落实成产品设计文档,作为与客户及研发人员沟通的媒介。 

      产品开发人员为了与产品经理与其它开发人员更好的沟通,一般会书写技术方法文档及设计文档,技术方法文档更多的是与产品经理及项目经理沟通的, 而设计文档更多的开发人员所在团队用了参考评审的。

      产品测试可以分为单元测试,功能测试,集成测试,稳定性测试,性能测试,测试建议不要用模块开发人员,避开思维惯性,当然对于功能测试,集成测试来说可以用白盒与黑盒两种方法进行测试,将相关测试点落实到测试文档中,方便审阅验收。

     产品发布需要发布文档,发布文档里会罗列新增的功能,修订的问题,测试报告。

     产品验收更多的是白盒测试,对产品所要功能进行测试。

     产品维护文档,一般是产品监控说明,产品报警机制,报警分类,及怎么解决等。

     现今的开发模式越来越倾向于轻文档,重编码的开发惯例,不过,在某些情况下,文档或多或少还是有它的用武之地,基于个人经验,总结一些相关文档模板供大家参考。


产品设计文档

1 产品/模块背景

1.1 产品/问题声明

         注释:描述一下产品由来,或许是产品不足,需要增强,或许是新的市场需求,或许是新技术等

1.2 产品分析

         注释: 描述一下商业客户应用,或者特定消费级用户使用情况

2 用例

         注释: 描述实际用例,怎么用

3 功能需求

3.1 功能需求 1

           注释: 用表格,图片或文字叙述方式,描述功能需求

3.2 功能需求2

            注释: 用表格,图片或文字叙述方式,描述功能需求

3.3 功能需求 ...

             注释: 用表格,图片或文字叙述方式,描述功能需求

4 验证

4.1 正确性验证

             注释:白盒测试,对功能需求正向数据进行验证

4.2 错误验证

             注释:白盒测试,对功能需求逆向数据进行验证

5 参考




技术方法文档

1 模块作者

      注释:开发人员/测试人员/部署人员

2 产品文档

2.1 问题声明

2.2 变化内容

2.3 变化前

2.4 变化后

2.5 用户影响

2.6 服务影响

3 解决方案

     注释:可以有多个解决方案,供大家选择

3.1 解决方案1

3.1.1 方案拆分

      注释: 方案需要涉及到哪些模块需要修改支撑,比如说前端,中间件,后端服务,数据库等

3.1.1.1 模块方案

      注释:简要描述模块所需支撑的功能,及接口是否改变

3.1.2 性能影响

      注释: 描述加入模块后对性能的影响评估

3.1.3 实施影响:

      注释: 描述是否需要环境改变支撑,比如带宽,内存等

3.1.4 模块依赖

       注释: 描述所依赖的模块

4 修订历史记录

注释:以表格形式列出修订历史记录,什么时间,改了什么方便查阅




技术设计文档

1 产品设计文档链接

注释: 可选的,可以加入产品文档链接方便参考

2 商业需求

注释:可选的,从客户角度描述一下商业需求,一般在产品设计文档赘述

3 用例

注释: 可选的,描述主要的用例

4 影响模块

注释:以表格形式列举那些受影响,那些不受影响,比较重要,因此在技术方法文档与技术设计文档都会阐述

5 影响接口

注释:以表格形式列举受影响的接口,及相应调整,应考虑前后兼容,或者如果不前后兼容,部署怎么解决对客户透明,0下线

6 技术设计

注释:描述系统架构,逻辑,流程,你可以用文字,伪代码或uml图的方式清晰表达你的设计思路及实施方案。常用的工具:Viso, wiki, StarUML etc。灵活运用用例图,组件图,类图,时序图,流程图等。设计应遵循以下原则:

        正确性: 一切以正确性为前提,设计及执行均满足产品设计需求

       健壮性: 程序至少经得住7*24稳定性测试

       可用性: 易用,运行时间在运行结果符合市场预期

       可行性:部署经费与开发时间可控

       可扩展:松耦合的模块内部设计,一般推崇SOA

        可实施: jenkins的持续集成持续部署

7 前提/限制

注释:可选的,模块运行需要前提条件,当前功能是否还有一些限制条件

8 实施/监控

注释:实施部署是否需要申请新的机器,或者原有机器是否需要磁盘或内存扩容,是否需要安装新的第三方库(第三方库是否开源,是否需要获取授权),数据库表格是否需要变化,数据是否需要做提前迁移,是否需要监控,监控哪些内容:如进程,进程资源消耗,进程是否有报警机制

9 测试环境变化

注释:从开发的角度,告知测试哪些人员,测试模块需要环境:是否需要安装新的软件及第三方库,运行的操作系统,测试配置等

10 工作计划

注释:以表格形式列举设计评阅,代码评阅,测试评阅,测试报告评阅,集成测试评阅,部署的相关时间点。

11 引用

注释:加入设计文档相关的文档或技术链接以供参考




测试文档

1 背景知识

注释: 加入这些文档(产品设计文档, 技术方法文档, 技术设计文档)的链接以供参考.  

2. 测试结果

注释: 

测试代码覆盖率:单元测试与集成测试

功能测试结果:多少个测试用例,是否全部通过。

稳定性测试结果:7*24,什么并发下稳定测试结果

性能测试结果:

3 测试用例

注释:用表格形式列举所有测试用例:输入,输出,期望结果,测试结果,是否通过

4 部署后检查

注释:从数据库,服务端口方面,原有模块及新上线功能模块白盒测试检查

5 参考





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

推荐阅读更多精彩内容