我应该用什么语法时态写规范?


21

我们目前正在以两列格式编写功能和技术规范;摘要句子和技术细节。细节通常是指带有图表,布局设计等的附录。

但是我正在努力用什么时态来写它:

以过去的时态好像工作已经完成了,我努力地展示出现有工作的重点扩展。需要完成的将来时态X听起来很像一个待办事项列表或时态中立,因为它要么已经完成,要么已经完成。

更进一步的混淆是,英语不是第一语言的人们可能会阅读本规范。

Answers:


12

在我最后的工作地点,我们已经做了很多工作。

产品经理选择使用现在时来描述必须完成的工作,例如:

用户发送订单。系统发送确认消息。

不幸的是,前提条件的描述也以现在时进行,例​​如:

用户将商品放入购物车并指定数量。

因为不清楚已经是什么和即将发生什么,这给我造成了很多困惑。我试图使它们使用任何将来时态,但它们永远都不需要改变。就个人而言,我在那里呆了整整两年。只是没有任何意义,听起来好像没有人掌握语言时态。


因此:

  • 用现在时来表示已经存在的时态

  • 使用将来时表示必须执行的操作。运用世界“应该”,“必须”,“将”。


要记住的重要步骤是重新查看规范。完成后,请确保将措辞从将来更新为现在。
本L

@BenL:不,那是错误的。时态用于表示如何提供正确的实现,而不是指示实现的状态。在此,将来时态用于表示将来的应用程序状态,而不是将来的实现状态。顺便说一句,值得注意的是,大多数RFC也使用此处提倡的方法。请参阅RFC 2119,以了解有关术语“必须/必需/应该(不是),应该/推荐(不是)以及可以/可选”的讨论。
布赖恩

5

现在时对我来说似乎很好。

  1. 前提条件:Foo处于X状态
  2. 操作:发生的事情
  3. 后置条件:Foo处于状态Y

所有这些都是现在时。

或者,如果这是“项目状态”

  1. 版本10:具有功能A,B,C和D

  2. 版本10.1:包含对A的改进。修复了B中的错误1049。添加了新功能E。




1

当我为软件创建设计时,我倾向于现在时,即使我在软件存在之前创建设计。即使从设计中实现了软件应用程序,设计仍然是相关且重要的文档。在软件实施之后,与在实施之前相比,设计文档很有可能会保持相关性更长的时间。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.