如何撰写文档

今日听了魏老师的如何撰写产品文档的课程,收益良多。

先说下撰写文档的前提:

1、明白是给rd/qa写的,明确他们关心的问题和角度;

2、能写多细写多细;伪代码是最好的;

3、做好前期准备工作;

a)梳理思路;

b)流程图;

c)原型图;

d)落实文档;

4、重视内外需求评审;需求评审是内部了解你需求的人对你的需求、文档的补充和意见;

5、一图胜千言

6、别说废话,说话写字注意重点,明白你要干什么,言简意赅表达出来;

另外,听完演讲最重要的是,不要犯重复的错误,这适用在产品的任何事上,方法论也是一样,上次和师父讨论也指出这是最重要的问题,最笨的方法是建立错题本;我相信你一定有简单的办法;

另,总结下写文档模板:

1、做好文档管理,包含上线版本、日期、变更记录等;

2、需求背景(你为什么做这个需求?发现了什么问题,怎么解决?)

3、需求收益(做完的收益是什么?产品/公司层面收益,用户收益,可衡量的指标)

4、需求流程图;

5、需求描述(按模块分,前端交互(ui图)、后端交互(流程图/泳道图)、边界情况、异常情况、断网情况、性能要求)

6、qa需要特别注意的点;

7、埋点

以上标粗的,是我经常遗漏的点,之后需要注意。。。

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

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,834评论 25 707
  • Gaurav Oberoi 是 SurveyMonkey 的(前)联合创始人,曾于 Amazon、Xmarks 先...
    Tomy阅读 1,627评论 2 36
  • 相关文章: 《再说说APP测试设计-1》《再说APP测试设计-2》《关于ad hoc test》《干了这碗蛋炒饭 ...
    慧众rodman阅读 3,203评论 1 34
  • ffffrtt阅读 110评论 0 0
  • 昨日晚饭后陪悠妹看了一阵书,接近八点,她提出想看会儿动画片,给她选好影片播放。我这两天一直想去理发,觉得...
    1803阅读 155评论 0 0