当前位置:首页 » 电脑办公 » 怎样写需求文档
扩展阅读
做牙齿矫正一般多少钱 2024-09-21 14:47:01

怎样写需求文档

发布时间: 2022-01-14 15:10:47

‘壹’ 怎么写项目需求文档

如果你是真的想写,希望你实地到超市去考察下,看看他们的工作流程,然后按流程写,写不好,至少是真实的,而且对你也会有帮助,如果不是,那你从网上找找,有很多

‘贰’ 怎么写需求文档啊

我是个小学都没毕业的人,但我还是知道你要写的是什么,需求文档,你要明白,是你们公司需要的各种材料的内容,计费嘛这个你自己懂的。

‘叁’ 硬件需求文档怎么写

1、首先根据功能分类
2、分别简介结构、原理
3、介绍各部分采用的理由、特点
4、主要元器件的选择及理由
5、列出元件列表。

不知是否是你需要的答复。

‘肆’ 如何编写优质的需求文档

需求文档被用来定义开发任务,协调大规模的研发计划。对于最终的产品,需求文档扮演着开发者行为和消费者行为之间沟通纽带的角色。当需求文档书写正确的时候,便可以发挥巨大的作用。然而,如果你在嵌入式开发领域工作的时间足够长,你就会很快发现,这个领域里不合格的需求文档实在是太多了。当你尝试对这些不合格的文档进行修复时,你又会很快发现,书写正确的需求文档绝非易事。在这里,我们提出一些建议,希望能将书写正确需求文档这件事情变得清晰一些。 从较高的层次来看,书写需求文档的目的就是要提供对所需行为的有效描述。该所需行为可用一个黑盒系统描述,并需要注意以下细节:工程师可以根据系统所说进行实现测试人员,在不与开发人员沟通的前提下,可以利用满足硬件要求的设备验证需求。最终产生的成果满足终端用户的要求。黑盒测试 书写优质的需求文档: 最基本的原则是:需求文档应当尽量简洁,用最易懂的描述来约束系统的预期行为。如果你遵循这个原则,剩下的那些重要因素(可测试性、避免过度设计等等)都将变得顺理成章。 列举一下更详细的规则,通常会更有帮助。下面是书写优质需求文档需要遵循的步骤: 1. 定义系统的边界。这也是黑盒系统所必要的。 2. 定义输入和输出。这也应当是你看待内部系统的唯一方式。 3. 用最易懂的方式描述系统的预期行为 4. 除了输入和输出之外,你的需求是不是还涉及了系统的其他部分?如果是,那么你的需求就设计过度了。重构需求,让它变得精简。 5. 你的需求是不是过于模棱两可?加入更多的限定规范。注意:有些模棱两可的描述并不是坏事,假设描述所包含的所有情况均可被接受,且测试的时候不需要附加的信息加以说明,那么就没关系。你不需要(也不应该)把系统的行为限制得过头。 6. 你的需求是否可测试?(这里指的是黑盒测试)如果不是,你最好返回到第 4 步。如果这种返工发生很多次,那就说明你的黑盒无法正确描述系统,或者你的测试工具不够优秀。无论是哪种情况,不可测试的需求文档几乎就是一文不值的。 7. 你的需求文档通俗易懂么?如果你的需求文档非常难以读懂,那就说明你写得不好,只能给那些照着你的需求负责实施的人带来无尽的痛苦。如果是这样,回到第 3 步。 8. 你是不是真的做到了第 4 步?你确认么?再检查一下。 例子:下面的例子,让我们描述一个自制的嵌入式设备的需求,这个设备能从弯曲传感器上读取弯曲的频率,并根据不同的频率值让一个 LED 闪烁。 显然,我们已经完成了步骤 2 和步骤 3 了! · 输入:从弯曲传感器读取数据。 · 输出:LED。 但是我们跳过了步骤1: · 在这个例子里,我们将把黑盒画到设备的微处理器上。 让我们继续往下进行, 第四步:除了输入和输出以外,我们是否还涉及了其他的系统边界? · 微处理器并不关心从弯曲传感器读取什么样的数据,从处理器的角度来看,仅需要做的是测量 ADC 脚的电压而已。 · LED 仅由数字输出脚控制。 下面,让我们来修正这个问题: 第0 版本的需求: 1. 该设备应当根据 ADC 脚的不同频率的电压,来切换数字输出端的状态。 第五步: 需求写模棱两可么? 恩,我们的描述太模棱两可了.输出端切换的速度要多快? 跟电压的关系如何? 输入电压的范围是多少? 让我们加一些更细节的描述吧: 版本0.1 1. 输出端应当由一个自由活动的定时器进行控制 2. 自由运行定时器的频率最高不得高于每秒 10 次,不得低于每秒 1 次. 3. 自由运行定时器的触发频率应当在最高和最低值之间呈线性变化,并与 ADC 端的输入电压成正比. 4. ADC 端的输入电压应当每 100 毫秒读取一次 5. 当 ADC 端的输入电压端被读入时,控制自由运行定时器周期时间的注册值也应当被更新. 6. ADC 输入端的电压有效范围应当被控制在 0 到 1 伏之间. 第六步: 你的需求是可测试的么? · 首先,自由运行的定时器在这里不需要提及. 因为对它基本上无法进行黑盒测试,它既不是输入也不是输出,而且跟这两者也没有什么联系。 让我们用“数字输出端变化的频率应控制在每秒 10 次和每秒 1 次之间”来代替自由运行定时器的测试标准。 · 对于上述的第四条需求,可能需要一些小修改才能作为测试标准。让我们用“ADC 端的输入电压应当保证在每 100 毫秒内至少被读取一次”来加以描述,这样的描述能让我们预期的测试行为显得更加通俗易懂。 · 需求的第五条也需要一些小修改。我们如何才能检测电压的输出范围是在 0 到 1 伏之间呢? 总不能给个 2 伏的电压,然后看看元器件有没有被烧毁吧? 那么,说“检验系统在 ADC 端输入电压为 1 到 2 伏之间的时候,工作是否正常”,这样就检验就容易多了。需求描述应当是“正面”的,应当描述设备“应该”的行为,而不是设备“不应该”的行为。否则的话,测试将会无法进行。 版本0.2 1. 数字输出端的切换频率应当控制在每秒 10 次到每秒 1 次之间 2. 数字输出端的切换频率应当在最大值和最小值之间呈线性变化,并与 ADC 端的输入电压成正比 3. ADC 端的输入电压应当保证在每 100 毫秒内至少被读取一次 4. 检验当 ADC 端的输入电压范围在 0 到 1 伏之间的时候,系统工作是否正常 第七步:你的需求是否通俗易懂? 相比于我们原来的描述:“根据弯曲传感器的输出不同频率来控制 LED 闪烁”,我们上面的那些需求描述显得难以阅读和理解。 我发现,让需求文档变得通俗易懂,最简单办法莫过于,把过于细节的东西抽取出来,然后以条目的形式单独定义。 版本1 1. 弯曲传感器应当保证至少在 100 毫秒内读取一次数据(放到注释单独列出) 2. 切换 LED 的状态,使其与弯曲传感器的读数保持一致 3. 当弯曲传感器的读数为 1 伏特时,LED 状态切换的次数应当保持在平均一秒十次;当传感器的读数为 0 伏特时,LED 的切换次数应保持在一秒 1 次。 定义: · 弯曲传感器:输入电压位于 ADC 的X端。安全电压范围为 0 到 1 伏特(放到注释单独列出) · LED 状态:数字状态由Y端输出 这样就好多了(尽管还不完美)。这些需求通俗易懂,不涉及到系统内部实现,且易于测试。对于系统行为的限定也仅仅限于需要做什么,点到为止。(例如,对弯曲传感器的采样频率,在实现上也可以更高,只要不产生非预期行为,一切都可以)。 编写需求就仿佛是在大脑中构建软件的过程。因此要重于实作。 编译:伯乐在线 – 黄小非

‘伍’ 如何编写优质的需求文档

尽量简短

没有比这更重要的文档写作建议了。简洁意味着清晰的思路和沟通,也意味着你的文档更加易于阅读和理解——这一点至关重要。


使用平白的语言和简单的格式
使用简短而不是花哨的语句,使用列表和加粗强调可以使文章更一目了然,以放松有趣的方式写作而不是一板一眼,如果你有得体的幽默感就再好不过了。


为开发团队预留时间
通过评审并且达成一致通过的文档才是完善的文档。如果你希望在未来的某一个迭代 Sprint 中开发此项目,就应该提前两到三周开始这个产品文档写作流程。


像工程师一样思考
在项目得以进入开发之时,常常会发现大量未预料到的边缘情况——但这种情形其实可以避免。如果你认真考虑过项目进入开发的所有必要条件,你就可以提前发现这些问题(例如,是否在移动设备中可以使用在线聊天功能?)。


确保每一个人都跟上了你的节奏
当我组织产品评审时,会议室里的大部分人都已经大致了解我要讲的内容——因为我已经提前在讨论会和日常聊天中沟通过这个事情了。既然大家都已经清楚了“做什么”和“为什么要做”的问题,文档评审会上我们只要关注实施细节就好了。


在图表中下功夫
流程图、线框图等图表可以通过易于理解的方式提供很大的信息量,同时也需要消耗非常多的时间来制作这些图表。


在思考和写文档上花 0.5-3 天时间
具体时间根据项目大小而定。花费在写文档上的时间越长,所带来的边际收益就会递减。特别需要指出的是,没有人能够读的下去超过 5-6 页的文档。


指明方向,明晰愿景
你不仅仅是在定义一个功能,也是在解释“为什么我们要做这件事情”以及“我们的目标是什么”,在文档中指出这个项目将会对更高层面的规划造成什么影响,以及接下来会发生什么。


确保你的观众阅读了文档
如果你的文档又臭又长,或者从来不分享给对应的人,那你还不如不写文档。务必确保你的文档被对应的人阅读了,我上面关于评审开始时留时间给大家读文档的建议值得大家参考。


获取真诚的反馈
你的文档是否是在赘述人尽皆知的事情?或者是文档缺乏足够的细节?是否在后续实施中发现了太多的边缘情况?又或者,是否在制定计划和文档评审上耗费了太多的时间?你应该和你的团队时刻保持沟通。

‘陆’ java 项目需求文档要怎么写

5.在线预览、分享更便捷

在摹客中在线撰写或上传的产品需求文档,可通过链接快速分享给团队成员,团队成员获得链接后可自由查看,当产品需求文档有修改时,团队成员仍可通过链接查看最新版本。

使用摹客等高效便捷的产品文档撰写工具,可以简化产品文档撰写流程,提升产品经理的文档撰写能力,让产品经理事半功倍。

总结

产品需求文档作为产品开发团队的重要沟通文档,文档的质量好坏会直接影响到各部门是否能够明确产品的功能和逻辑。一份简洁易懂、逻辑清晰的产品需求文档,可以让团队沟通更加高效,从而有效提高产品开发团队的工作效率。

‘柒’ 需求分析文档的正确写法有哪些 谢了!!

没有什么正确不正确,主要是为了搞明白用户真正的要求,分析问题的解决方法,提供一个大致解决方案、思路,使大家都知道面对的是个什么要的问题,需要如何去做;

‘捌’ 需求文档怎么写最有效

能将功能需求写清楚的就是好的需求文档,因为现在的需求文档一般都是给开发看,一般来说创业公司追求小步快跑快速迭代的开发模式的话,需求文档不是一个很有必要的东西,直接在原型上表述效率会更好。如果公司追求规范管理的话,建议还是需求文档,写清楚项目名称,迭代版本,及相关的日期规划。

‘玖’ 怎样才能写好项目需求文档

要想写好项目需求文档就必须深入客户,了解他们的真正需求,多和客户沟通,尤其是跟软件项目的直接操作者沟通,看他们有什么样的需求,他们想怎么用这个软件项目,这些都很关键,有的时候还需要你长期在客户那里实习,进一步了解客户的真正需求,把投资风险降到最低。收集好资料后就需要自己多整理,从中发现客户没有提出的需求,整理成需求说明文档!

‘拾’ 如何写互联网产品需求文档

你好,网上有很多产品需求文档的例子,你可以参考一下,大致有以下这些内容:

首先自己要能理解需求,知道具体是要做一个什么样的产品,产品的主要用户是谁,产品有哪些主要的功能
然后你能把这个需求描述给团队其他成员,让他们也能明白这个需求
最后在和团队其他成员沟通的过程中你能解决他们提出的一些问题
产品背景、需求描述、关键词/字、功能结构、功能流程图、页面流转图等