TEL:0757-88818598
首页

产品文档(一):“优异”的文档结构 米乐体育手机版登陆


发布时间:2021-11-22 16:31:42 来源:米乐体育手机版登陆


详情介绍:



  需求文档/产品文档是每个产品司理的必经之路,优异的产品文档能够防止部分项目的重复沟通和编写无效代码,进步项目开发功率。

  “这儿是不是少了功用按钮?”“这段话是什么意思?”“不行呀!你的文档需求弥补,否则怎样测验?”“口头的需求文档不算数,开发要见文字版文档”。

  本文献给0-1岁的产品司理,从需求文档的目的、与用户手册的差异、需求文档的构成的维度对需求文档进行全体介绍,期望各位PM都能够输出高效精简、明晰明晰的文档。

  写需求文档前,首要要承认的是文档的受众集体和时刻要求。受众集体(谁去看)承认了文档的结构架构和排版要求;时刻要求约束了需求文档的精密度和漂亮度。

  (1)开发团队:包含产品团队、UI、UX、技能和测验;这也是最惯例的受众集体,究竟需求文档是要论述项目要完结的功用和完结的办法、规矩。

  (2)企业界部:如老板、商务团队、运营团队等;一般这部分集体不会在乎产品规矩,他们只关怀项目完结的功用和作用。

  (3)其他:例如公司准则要求留档、公司上市审计流程所需。我还才智过另一种进程:面试。假如在面试时提交的著作是需求文档,那么请看“商用文档”部分。

  假如仅仅开发团队运用的需求文档(以下简称开发用文档),结构会比较简略,排版也没有十分谨慎的要求,只需求做到逻辑闭环,场景尽善,表达明晰即可。假如是企业界部或其他用处的需求文档(以下简称为商用文档),除了开发用文档的内容外,还需弥补项目概述、需求剖析等栏目,这部分将在下文“商用文档”再具体解说。

  在写文档前,PM心中有必要要有期限和计划,合理安排文档的进展,不能在项目前期就产生延期的状况。

  假如时刻急迫,首要要把要害的逻辑写清楚,其他的细节能够在开发时或项目完毕后弥补,例如查找功用、填写字段的字符长度、页面承认、封闭和回来等交互。特别是当项目团队已有必定的协作阅历,树立了必定的作业默契时,这些细节在时刻不允许状况下是能够省掉,究竟PM也有许多更值得做的作业。

  可是,假如时刻富余或许是新的开发团队,个人仍是主张需求文档尽量精密,究竟见过许多规划师、开发和测验吐槽需求文档不清不楚,作业难以展开。再者,具体的需求文档,能够大大地削减开发团队的了解误区,必定程度上,既能防止无效规划和无效代码,还能防止产品司理在投入下一个迭代作业时被开发“咨询”过多。

  需求文档描绘的是项目的功用和产品逻辑、规矩,倾向逻辑描绘;而用户手册是描绘项目的功用和运用流程,倾向操作流程阐明。两者间都需求告知各自的读者,功用是什么、有什么用;但出于目的不同,所以主题内容和具体程度也会不相同。看看家里的电器运用阐明书,就知道怎样写运用手册了。

  我个人也是写开发用文档比较多,渐渐形成了自己的结构标准。今后跟着阅历的堆集,也会持续优化这套办法论。

  主要是记载一个项目各个产品版别的迭代状况,如V1.0,V1.1……V2.0……。这儿着重的产品版别,主要是指产品功用的迭代。假如一个迭代只单纯触及到bug修正、交互优化、功用优化,记不记载都能够,看个人志愿。

  需求记载的内容包含:版别号、更新日期(文档定稿日期或许版别上线日期,个人更主张用版别上线日期)、主责产品司理、迭代的功用简介(从事务场景动身,一句话描绘一个功用模块)。

  主要是记载单个版别(划要点)的修正记载。因为每个需求文档都会阅历初稿、产品评定、技能评定、开发进程中N次细节调整、终稿这几个进程,需求把每次修正的当地记载下来,特别是当文档现已对项目团队揭露后产生的修正。

  需求记载的内容包含:更新日期(每次文档修正的日期)、产品司理(不同等该版别的主产品司理,特别是大项目有一个主产品司理,多个初中级产品司理)、修正阐明(动了哪些逻辑,哪些页面)。

  版别迭代记载是为了给今后的项目团队运用,无论是产品仍是开发,便利新成员或项目交代时快速了解项目的宿世此生;版别修正记载是给其时的开发团队运用,便利快速了解产品又改了哪些逻辑,添加了哪些需求(温馨提示:投入开发后真不要容易加需求)。

  一般写在文档里的流程图包含两种:事务流程图和逻辑流程图,都是“非必填项”,视实践状况判别是否需求用流程图进行阐明。因为在开发用文档内,任何元素都是为了协助产品司理明晰阐明需求,假如事务很简略,能用线框图或许文字即可阐明清楚,那么就没必要费力气去弄一个流程图了。

  事务流程图:一般单个使命模块从0-1的时分需求运用,协助开发了解使命的每一个环节。一般会触及到多个人物协作。比如见文末开发用需求文档。

  逻辑流程图:单个使命或许单个环节触及多重逻辑判别时运用,协助开发整理if else后的操作行为。假如单纯用文字描绘这种逻辑判别,开发还没绕晕,产品自己或许就先绕晕了。

  在同一个体系内,在多个场景或许页面内需求运用到相同的组件或许交互,把这类组件/交互的需求阐明归纳到大局阐明内,在正文内呈现时做相关引证即可。

  列表的排序规矩,假如多个页面的列表排序规矩都是相同,则在大局阐明内新增一个版块对其进行具体阐明,而在正文的相关页面注明“排序规矩请参照大局阐明XXXX”即可。

  又如体系管理后台,修正页面的保存/撤销功用,直接在大局阐明内阐明,点击保存/撤销时会呈现XXX提示,承认后体系的履行成果;即便在实践页面中,保存/撤销归于不同的内容修正页面,但其交互简直都是共同的,就没有必要在多个页面重复阐明。假如遇到特例,与大局阐明内的需求不相同,在对应的页面再另行阐明。

  树立大局阐明板块,不只能在写需求文档是节约重复劳动的时刻,而且在修正需求文档进程中也能省掉许多繁琐的事,就如Axure中“母版”相同快捷,改一处即把相关的当地都完结修正。

  关于交互阐明,一般大公司才会有专职的交互规划师并编撰交互文档,其他公司一般由产品司理和UI规划师一同承当交互规划。但无论是否有专职的交互规划师,我以为作为一名产品司理,在需求文档内也要明确指出部分交互阐明,供给一个大方向给规划师作业,特别是关于体系的空白页或类空白页。

  前段时刻在处理一个小功用:在非电话客服作业时刻内,用户点击电话客服按钮时,需弹出提示并引导用户在线留言。

  因为其时需求内没有具体阐明交互目的,UI规划师被线框图误导,出了榜首版别;我看了规划后不太满足,与UI规划师沟通主意后,终究修正为第二版并投入开发。

  两个版别的信息内容是相同的,但因为信息侧要点相反,因而这两个提示的功用也不共同。榜首版侧重于告知用户“其时客服不在线”;第二版侧重于引导用户在线留言。产品是要为用户供给处理计划,而不是把问题抛回给用户。

  写商用文档无形中也会给产品司理添加十分大的作业量,因而可按公司要求和个人习气结合去挑选即可。

  每一份商业化文档,都会要求有一个封面,简略罗列体系称号、文档称号、文档规划者(企业或许个人)、定稿时刻即可。

  主要写项目前期展开的调研和剖析而得出的定论,包含产品定位——项目中心用户群、市场竞争优势,和用户故事——用5W1H办法标明处理的痛点。

  对体系或许文档内的一些专业用词进行解说,或对同一事物进行命名标准。体系字典不只是一个项目内运用,乃至每个部分或每间公司都能够用相关概念,特别当团队刚刚组成时,运用体系字典概念能够处理许多沟通上的误解。

  就如上文的“大局阐明”,这儿用“大局”代指整个体系的概念。但实践,更多的公司/团队用“全域”来指代整个体系。但因为公司是旅行职业,“全域”一词是职业界的专有术语,而且也是公司的事务术语,假如用“全域”来表明整个体系,在沟通经常常会引起误解,因而公司内部都习气运用“大局”来指代整个项目体系。

  (补白:商用文档为“当年”自学转行产品时的作业,相对幼嫩,我们看看结构即可,不用较真哈)

  为了协助产品新人快速把握文档编撰基本功,这儿引荐由起点学院联合惠买集团产品总监@陈滨淋 教师打造的【15天把握产品司理必备文档】学习计划。从实例动身,带你高强度体系性学习11大类常用的产品作业文档,快速帮你标准化日常文档,提高作业功率

  计划2:或许直接进入留言页面,在该页面顶部横幅解说一下为什么没有拨电话而是进入这样一个页面。能削减页面,总感觉那个弹窗剩余了。

  关于计划2,便是归于交互体会的评论:什么时分适合用什么提示办法。感觉又有能够写文章的内容了耶~~~


上一篇:一个产品的从0到1的全流程
下一篇:产品规划流程系列:事务流程和图介绍

产品中心


米乐体育手机版登陆





总部:佛山市高明经济开发区
电话: 0757-88818598   13316298838
传真: 0757-88819920
邮件:
sales@chinawwt.cn

销售部:

地址:广东省广州市越秀区淘金路36-38号帝景大厦

电话:020-85586857    

传真:020-38461041


24小时销售服务热线:18610757988