课程咨询: 400-996-5531 / 投诉建议: 400-111-8989
认真做教育 专心促就业
设计文档是软件开发程序员在开发软件之前都会提前准备的一个工具,而今天我们就通过案例分析来了解一下,设计文档的作用与结构包含哪些内容。
设计文档的结构
设计文档是非正式文档,因此它们的内容不会遵循严格的准则。一个要原则是,针对具体项目可以用任何合理的形式编写。
话虽如此,形成的特定结构必定有其价值所在。
上下文和范围
这一部分会粗略地向读者介绍新系统是如何构建的以及实际情况如何。这不是需求文档。请保持简洁!我们的目标是直接让读者了解新情况,但先前的一些情况可以被推测或者能链接到详细信息。这个部分应该完全聚焦于客观背景事实。
目标和non-goals
这一部分会列举出系统目标是什么,但有时候更重要的是,列出系统的non-goals。注意,non-goals并不是像“系统不应该崩溃”这样的负面目标,而是那些本可以合理地成为目标但却明确地选择不作为目标的东西。一个很好的例子是“ACID准则”;当设计数据库时,你肯定想知道这是一个目标还是一个非目标。而如果这是一个non-goals,如果它不会阻碍目标的实现,那你仍然可以选择一个提供它的解决方案。
APIs
如果正在设计的系统暴露一个API,那么勾勒出这个API通常是个好主意。然而,在大多数情况下,人们应该按捺住将正式接口或数据定义复制粘贴到文档中的诱惑,因为这些定义通常都很冗长,包含一些不必要的细节,而且很快就会过时。相反,人们应该聚焦于与设计及其权衡相关的部分。
数据存储
存储数据的系统应该讨论如何及用何种大致的形式存储数据。和关于API的建议类似,并且理由相同,应该避免复制粘贴完整的模式定义。相反,要聚焦于与设计及其权衡相关的部分。
代码与伪代码
除了一些描述新奇算法的场景,设计文档应该很少包含代码或伪代码。在适当的情况下,可以链接到设计实现的原型。
【免责声明】:本内容转载于网络,转载目的在于传递信息。文章内容为作者个人意见,本平台对文中陈述、观点保持中立,不对所包含内容的准确性、可靠性与完整性提供形式地保证。请读者仅作参考。更多内容请加danei0707学习了解。欢迎关注“达内在线”参与分销,赚更多好礼。