撰写技术需求文档的明智之言

准备技术需求文档(也称为产品需求文档)是创建或修改软件系统或其他类型有形产品的任何项目的典型部分。ob欧宝娱乐app手机下载投入时间和精力准备技术需求文档有很多好处。本文讨论了其中的一些好处,并包括编写技术需求文档的技巧。你还会遇到三位专家,他们会提供他们的建议和经验:瑞秋·s·史密斯前SCU分布式学习中心高级界面设计师,蕾妮·费尔曼,屡获殊荣的企业转型专家,以及迈克尔Shrivathsan他是Accompa公司产品管理副总裁。ob欧宝娱乐app手机下载

此外,您将发现其他类型的需求文档的简要描述,这些文档要么与技术需求文档重叠,要么与它们混淆。也有一个讨论敏捷建模,这是为公司和教育机构生成技术文档以及对IT需求进行简短审查的一种方法。

虽然本文提供了有用的指导来帮助您创建技术需求文档,但您也可以按照自己的方式来做。“每家公司都有不同的文件政策和做法。确保您了解公司的政策,并制定适用于您和您的团队的技术需求文档。

为什么要创建技术需求文档?

雷切尔·s·史密斯,《编写需求文档他解释说,技术需求文档“展示了为什么需要一个产品,将产品置于上下文中,并描述了最终产品的样子。”ob欧宝娱乐app手机下载对于软件项目,技术需求文档通常指的是如何构建软件,包括为其编程的操作系统和其他标准。

根据Smith的说法,如果不创建技术需求文档,就会产生实际问题。这些问题包括:

  • 打造一个不能满足实际需ob欧宝娱乐app手机下载求的产品。
  • 开发“功能蔓延”。
  • 让团队中的一组人认为他们在建造一只蚂蚁,而另一组人认为他们在建造一头大象。

Renee Fellman是俄勒冈州波特兰市的一位商业专家,专门研究如何使濒临失败的企业扭亏为盈。她发现,未能充分记录技术需求可能会给公司带来严重的问题,从而影响公司的底线。

由于没有技术需求文档而产生的问题可能从简单到复杂。“在我咨询过的一家公司里,”费尔曼说,“重要的FDA合规问题没有得到解决,因为人力资源部门没有做好一些简单的事情,比如分配监管事务的责任。”欧宝体育app官方888

项目管理指南

您的一站式服务,一切项目管理


准备好从你的项目管理工作中获得更多了吗?访问我们全面的项目管理指南,获取技巧、最佳实践和免费资源,以更有效地管理您的工作。欧宝体育app官方888

查看指南

技术需求文件的价值

技术需求文档使您的团队能够相互理解在技术上需要什么才能使您的项目或产品成功。ob欧宝娱乐app手机下载走出项目管理的5个阶段,技术需求文档应该在项目生命周期的第2阶段创建。在这个阶段,你的项目范围被定义,目标被设定。技术需求文件还将提供有助于您的信息:

技术要求文件编制人员的期望

任何准备技术需求文档的人都应该了解什么是“好的”系统需求,以及如何以清晰的方式传达这些信息。

  • 记住以下几点:
  • 在分析技术需求时,要创造性地选择要探索的资源,并始终将业务需求作为基本参考点
  • 用容易理解的语言帮助别人理解你的结果
  • 使用原型来找出你所缺少的东西
  • 在决定包含哪些内容时,请确保您了解相互关系、优先级、成本、实施和环境后果
  • 定义系统边界

业务中常见的其他类型的需求文档

在确定您的初始技术需求列表时,请注意您公司内的其他团队也正在准备其他文档。这些文档是关于相同的项目,但针对不同的受众。这些文件中很可能有一些包含多余的信息。您可能会觉得有些项目属于技术需求文档,而不属于业务或市场需求文档,但不要担心—您可以将它们同时包含在两者中。由您来创建最适合您的目的的技术需求文档。确保你收集了对你最有用的信息。

Michael Shrivathsan,产品管理副总裁ob欧宝娱乐app手机下载Accompa他是……的专家需求文件的类型以及它们的功能。

Shrivathsan说:“在业务、市场和技术需求文档之间可能存在一些重叠。根据组织的不同,他们可能使用也可能不使用所有这些文档类型。在大公司(1000名员工以上),他们通常会使用这三种文档。大多数中型企业(200名员工以上)至少使用其中两种。”

这些其他报告中可能有重要的信息,可以通知、影响或创建与您的技术需求文档相关的突发事件。以下是其他部门可能创建的其他文件,以支持您的项目:

业务需求文件(BRD)
写的:ob欧宝娱乐app手机下载产品经理,产品营销经理
观众:业务经理
评审和批准:的执行者

业务需求文档定义了项目的高级业务用例,通常首先准备。

业务需求文档从业务的角度定义了项目的目标。此阶段的文档描述了高层的业务目标。这个团队的成员应该在你的公司或你的客户的公司会见合适的业务经理,以收集必要的业务信息,集中在你的业务和客户的需求。

从业务需求文档中,您可以了解到以下信息,这些信息可以帮助您编写技术需求文档:

  1. 客户需求的本质
  2. 满足这些需求如何与公司的使命相一致
  3. 你的产品、系统或软ob欧宝娱乐app手机下载件将如何在高层次上解决客户的需求
  4. 建议通过适当的流程、组织结构图或图表来描述项目中所有涉众之间的关系,以确保清晰度


市场需求文件(MRD)
写的:ob欧宝娱乐app手机下载产品经理,产品营销经理
观众:业务经理
评审和批准:主管
市场需求文件为BRD增加了更多的信息,包括市场需求,并为您正在开发的产品或程序确定当前的市场前景。ob欧宝娱乐app手机下载了解一些已经存在的东西,它是如何营销的,以及针对谁,可以帮助你确定其他产品功能的差距。ob欧宝娱乐app手机下载

从市场需求文件中,您可以了解到以下信息,这些信息可以帮助您编写技术需求文件:

  • 正在计划的产品类型ob欧宝娱乐app手机下载
  • 目标客户
  • 角色定义:
    • 客户特征
    • 他们面临的挑战
    • 你提出的产品将如何帮助解决这些挑战ob欧宝娱乐app手机下载
  • 竞争产品及其优缺点ob欧宝娱乐app手机下载
  • 让你的产品变得更好的方法ob欧宝娱乐app手机下载


如果你的公司没有人准备上述报告,你可能需要做一些额外的工作,以获得你的产品将存在的宇宙的全图。ob欧宝娱乐app手机下载

技术需求应该关注期望的结果

软件开发技术需求包括开发计划、技术架构、软件测试和部署等组件。Fellman建议,好的技术需求文档首先关注您想要的结果,而不是过度关注过程。为什么?因为你想去的地方决定了你将如何到达那里。例如,你不会骑骆驼到达珠穆朗玛峰的顶峰,但如果你的最终目标是到达埃及沙漠中的一座古墓,你可能会骑骆驼。

Fellman警告说:“在开始准备技术需求文档之前,如果没有提出正确的问题,可能会导致文档实际上无法解决您想要解决的问题。”

当然,问题会根据您的客户、您的公司以及预期的服务或产品而有所不同,但是对于技术需求文档来说,要探索您希望新系统或软件实现的功能—特别是从用户的角度出发。ob欧宝娱乐app手机下载你可能想咨询你的开发人员,从他们的角度询问,什么是可行的,什么是不可行的。

模板化的技术需求清单是有价值的组织工具

使用模板清单,例如Smartsheet中的需求收集清单,可以帮助您专注于应该收集的信息类型,作为技术需求分析的一部分。

一定要包括:

  • 功能需求和它将执行的任务
  • 从里程碑的角度来看,驾驶日期
  • 有形产品的物理要求,如尺寸、重量、颜色、形状、质地和坚固性ob欧宝娱乐app手机下载
  • 技术环境的细节
  • 数据需求
  • 外部接口
  • 兼容性和可移植性
  • 维护

从不同的群体收集信息
Smith建议这类文档的信息可以来自各种来源,包括最终用户、客户、开发人员和其他人利益相关者.信息可以通过访谈、调查、问卷调查、研究,甚至是团队之间和团队内部的圆桌讨论来收集。

雇佣使用分析
确定将使用你的产品的用户类型,并找出他们的使用模式。ob欧宝娱乐app手机下载这将有助于确定您希望达到的性能水平所需的任何需求。

开发用例
典型用户的交互模型应该包含在技术需求文档或业务需求文档中,使用案例图和案例报告。

探索需求和期望的结果
考虑为您的技术需求文档收集以下类型的信息:

1.定义最终用户的期望和需求,以及产品将如何在现实世界中使用。ob欧宝娱乐app手机下载问问题(这里有一些例子):

  • 你的产品或软件将为你的用户解决什么核心问题?ob欧宝娱乐app手机下载
  • 你希望人们在使用你的产品或软件时完成什么?ob欧宝娱乐app手机下载
  • 生活将如何变得更容易、更有成效?ob欧宝娱乐app手机下载

2.定义团队结构和突发事件

  • 哪些团队成员负责工作的各个方面?(记住上面费尔曼的例子,确保所有重要的工作职责都分配好了。)

3.定义产品ob欧宝娱乐app手机下载

  • 使用模型、叙述或列表。
  • 清楚地说明接口需求。
  • 明确客户或客户的需求,特别是如果产品或软件是根据客户的规范构建的。ob欧宝娱乐app手机下载
  • 定义开发阶段。
  • 包括具体的完成步骤,并创建一个最初的时间表,可以随着更多细节的发现和决定而改进。
  • 通过探索流程的哪些部分是相互依赖的,以及为什么是相互依赖的,来识别偶然性。

4.创建一个原型,以帮助明确用户在完成新产品或系统时期望的结果ob欧宝娱乐app手机下载


5.定义产品开发的整个生命周期,包括人员、过程、软件和技术开发、变ob欧宝娱乐app手机下载更管理


6.确保每个系统需求描述:

  • 它执行的相关功能。
  • 任何形式的限制,在设计、法律或监管约束或风险方面。
  • 操作地点、使用或存储的环境设计要求。

考虑系统质量
考虑以下几点系统质量在描述服务质量时,您需要满足业务和用户需求。

  • 可用性- - - - - -根据系统的资源、服务和对最终用户的可访问性,您可以期望系统拥有多少“正常运行时间”。欧宝体育app官方888
  • 〇潜在能力您的系统如何在不需要更多资源的情况下处理意外的使用高峰。欧宝体育app官方888
  • 性能-给定特定负载条件下的一系列用途,什么将是响应时间和潜在容量。
  • 可伸缩性——在不改变原有架构的情况下,容量和用户数量增加或减少的速度有多快。
  • 可服务性,监控、修复和升级硬件和软件系统组件有多容易?需要考虑的因素包括停机计划、基于使用模式的维护机会、服务可用性的关键时间、诊断和监控的时间表。
  • 安全-系统的安全性如何,包括用户和信息在传输过程中的授权和认证?

验证并细化您的技术需求

一旦你定义了你的技术需求,花时间去验证和完善它们。Smith说:“我们考虑的因素包括:有多少利益相关者要求给定的需求,有多少其他需求依赖于它,它是否会使系统更容易使用或执行用户无法通过其他方式完成的功能,以及其他定性度量。”

对于Smith来说,验证需求是一个让尽可能多的人关注需求、听取反馈并讨论保留或拒绝给定需求的含义的过程。“其实没有捷径。关键是要让关键利益相关者参与进来,与他们合作,理解并解决任何意见分歧。”

Smith预测,您永远不会知道是否已经捕获了所有必要的需求。“你可能会收集到比你需要的更多的东西。但是,一旦你有了它们,就把它们按优先顺序排列,并根据你的时间和预算来处理最优先的需求。有时候,最大的要求并不是最重要的。”

保持利益相关者在循环中

今天,有一些工具可以让涉众直接看到开发过程,在那里他们可以看到可视化跟踪的进度,在需求被实现时审查(但不能编辑)需求,并测试早期的原型。“软件开发是一件非常棘手的事情,”史密斯说。“人们在功能开发出来之前就对其感到兴奋,如果他们的期望没有得到满足,他们会非常失望。”因此,在产品发布后,让人们了解情况,让他们尽早接触并定期更新是提高最终用户满意度的关键。ob欧宝娱乐app手机下载

敏捷建模适合你吗?

敏捷建模(AM)是创建和记录模型的另一种方法,该模型可以部署在基于软件的系统和产品的开发中。ob欧宝娱乐app手机下载它的范围超越了技术需求文档,包括整个过程,并结合了基于最有效的价值和原则的最佳实践,以在给定时间和预算的情况下创建最佳软件。

要了解更多关于敏捷建模的知识,这里有一些推荐的书籍:

技术需求模板与软件

模板易于使用,成本也合适,但也有其他选择。Shrivathsan的公司Accompa生产需求文档软件,该软件可以管理基于冗余或误解信息可能出现的问题。

这个软件:

  • 跟踪这三种文档类型之间的依赖关系。如果业务需求文档中的某些内容发生了更改,它可能会对市场和技术需求文档产生级联效应。
  • 它提供了一个存储库来保存所有信息,以便可以轻松地使用(Shrivathsan提到,在大多数大公司中,这些信息可以分割成多个筒仓,使得查找和使用非常困难)。

“除了最小的项目,几乎不可能手动跟踪这些依赖关系,”Shrivathsan说,“因此需要一种负担得起的软件工具。”

技术需求文档的编写建议

编写技术需求与其他标准业务文档略有不同。编写它们是一门艺术,以便将使用它们来完成一个项目或构建一种新型软件的人能够理解它们。这里有一些技巧可以帮助您编写有用的技术需求:

  1. 使用简单直接的语言,这样每个人都能理解你的意思。
  2. 是简洁。以介绍性段落开始,然后加上要点来增加可读性。
  3. 保持你的句子结构简单,一次只传达一个主要思想。
  4. 有时一张图片胜过千言万语,特别是当它简化了一个概念或展示了一个概念与另一个概念的关系时。

教育机构和企业技术要求文件

一些教育机构和企业的网站上有专门介绍计算机硬件、软件和浏览器基本技术要求的网页。如果不满足这些基本的技术要求,学生、教师或雇员将无法访问内部网。对学生来说,这意味着他们不能参加在线课程。就企业而言,这意味着员工可能无法完成工作。

信息通常包括:

  • Windows和Mac平台的最低配置,例如最低处理器或CPU速度、最低内存和操作系统类型。
  • 上网时的网络连接速度
  • 当前支持的浏览器列表,以及下载它们的链接
  • 浏览器插件的当前列表,以及下载它们的链接
  • 互联网接入信息
  • 如何注册学校或公司的电子邮件帐户
  • 所需的软件

智能表格模板将您的技术需求转换为管理任何项目的工作清单

通过设计一个灵活的平台来满足你的团队的需求,并随着需求的变化而适应,从而使你的员工能够超越自己。

Smartsheet平台可以轻松地从任何地方计划、捕获、管理和报告工作,帮助您的团队更有效地完成更多工作。报告关键指标,并通过汇总报告、仪表板和自动工作流实时了解工作情况,以保持团队的联系和信息。

当团队对要完成的工作有了清晰的认识时,就不知道他们在同样的时间内能完成多少工作。今天就免费试用Smartsheet吧。

了解为什么超过90%的财富100强公司信任Smartsheet来完成工作。

免费试用Smartsheet 获得一个免费的Smartsheet演示