点击展开

新闻中心

OB电竞:产物文档(一):“优异”的文档框架
2022-05-15 19:37:49 | 来源:OB电竞官网 作者:ob电竞官网下载

  需求文档/产物文档是每个产物司理的必经之途,出色的产物文档可能避免部门项目标反复疏导和编写无效代码,降低项目开垦效用。

  “这里是不是少了功用按钮?”“这段话是什么道理?”“不可呀!你的文档须要填补,否则怎样测试?”“口头的需求文档不算数,开垦要见文字版文档”。

  本文件给0-1岁的产物司理,从需求文档的目标、与用户手册的区别、需求文档的组成的维度对需求文档举行完全先容,盼望列位PM都可能输出高效精简、明晰懂得的文档。

  写需求文档前,开始要确定的是文档的受多群体和期间恳求。受多群体(谁去看)确定了文档的框架架构和排版恳求;期间恳求控造了需求文档的慎密度和漂后度。

  (1)开垦团队:包罗产物团队、UI、UX、手艺和测试;这也是最旧例的受多群体,结果需求文档是要阐扬项目要告终的功用和告终的手段、轨则。

  (2)企业内部:如老板、商务团队、运营团队等;平常这部门群体不会正在乎产物轨则,他们只体贴项目告终的功用和恶果。

  (3)其他:比如公司轨造恳求留档、公司上市审计流程所需。我还见地过另一种进程:口试。倘若正在口试时提交的作品是需求文档,那么请看“商用文档”部门。

  倘若只是开垦团队运用的需求文档(以下简称开垦用文档),框架会比拟简陋,排版也没有极度厉谨的恳求,只须要做到逻辑闭环,场景尽善,表达明晰即可。倘若是企业内部或其他用处的需求文档(以下简称为商用文档),除了开垦用文档的实质表,还需填补项目概述、需求阐发等栏目,这部门将不才文“商用文档”再周密注明。

  正在写文档前,PM心中必必要有刻期和安排,合理安顿文档的进度,不行正在项目前期就发作延期的情状。

  倘若期间危急,开始要把枢纽的逻辑写领会,其他的细节可能正在开垦时或项目告终后填补,比如探寻功用、填写字段的字符长度、页面确定、合上和返回等交互。特地是当项目团队已有必定的协作经历,设备了必定的事情默契时,这些细节正在期间不应允情状下是可能省略,结果PM也有良多更值得做的事宜。

  然则,倘若期间富饶或者是新的开垦团队,个体仍旧创议需求文档尽量慎密,结果见过良多计划师、开垦和测试吐槽需求文档不清不楚,工为难以展开。再者,周密的需求文档,可能大大地省略开垦团队的懂得误区,必定水准上,既能避免无效计划和无效代码,还能避免产物司理正在参加下一个迭代事情时被开垦“征询”过多。

  需求文档描摹的是项目标功用和产物逻辑、轨则,倾向逻辑描摹;而用户手册是描摹项目标功用和运用流程,倾向操作流程诠释。两者间都须要告诉各自的读者,功用是什么、有什么用;但出于目标差异,是以核心实质和周密水准也会不相同。看看家里的电器运用仿单,就清爽怎样写运用手册了。

  我个体也是写开垦用文档比拟多,缓慢造成了本人的框架范例。自此跟着经历的蕴蓄聚集,也会一直优化这套手段论。

  紧假若记实一个项目各个产物版本的迭代情状,如V1.0,V1.1……V2.0……。这里夸大的产物版本,紧假若指产物功用的迭代。倘若一个迭代只纯正涉及到bug修复、交互优化、功能优化,记不记实都可能,看个体志愿。

  须要记实的实质包罗:版本号、更新日期(文档定稿日期或者版本上线日期,个体更创议用版本上线日期)、主责产物司理、迭代的功用简介(从交易场景开拔,一句话描摹一个功用模块)。

  紧假若记实单个版本(划要点)的改正记实。由于每个需求文档都市经过初稿、产月旦审、手艺评审、开垦进程中N次细节调节、终稿这几个进程,须要把每次改正的地方记实下来,特地是当文档曾经对项目团队公然后发作的改正。

  须要记实的实质包罗:更新日期(每次文档改正的日期)、产物司理(不等同该版本的主产物司理,特地是大项目有一个主产物司理,多个初中级产物司理)、改正诠释(动了哪些逻辑,哪些页面)。

  版本迭代记实是为了给自此的项目团队运用,无论是产物仍旧开垦,轻易新成员或项目交代时疾速体会项目标宿世今世;版本改正记实是给目今的开垦团队运用,轻易疾速体会产物又改了哪些逻辑,增补了哪些需求(温馨提示:参加开垦后真不要方便加需求)。

  寻常写正在文档里的流程图包罗两种:交易流程图和逻辑流程图,都是“非必填项”,视现实情状决断是否须要用流程图举行诠释。由于正在开垦用文档内,任何元素都是为了帮帮产物司理明晰诠释需求,倘若交易很简。

  游戏开发物语吧

ob电竞官网下载
OB电竞官网

ob电竞官网下载

联系电话:176 0301 6881

邮箱:sales@finscm.com

OB电竞官网