程序可视化

Question

我从一个web项目开始，我想将它的功能和功能写在专业人士的“纸上”。我必须与有关

• 目的和项目概况的所有信息准备项目的文档，
• 数据库结构，
• MVC和REST功能（模型，视图，控制器），
• 网站和小部件的布局和功能，
• 客户端/服务器通信。

我想准备的是一个项目的建议，我解释了这个想法和确切的解决方案，以及如何实施所有细节。

我该如何准备？我需要什么？你能告诉我一个例子吗？

Answer 1

专业人员专注于观众。这个文件的目的是什么，它需要讲述的故事？写作需要时间，而且必须与其他花费时间的方式平衡。

您是否需要将该项目出售给客户？还是管理？投资者？还是给你的合作开发者？或者它主要是为了你自己？

细节的水平会有很大的不同。演示文稿的形式和演示顺序也会有很大的不同。

是否足以只是做的白板讨论或牛皮纸会议几张快照，或者你需要一个光滑的小册子，视频和PowerPoint？

对于您可能希望把它所有的维基中的Web项目。

如果您有两种不同的公开，您可能需要创建单独的文档或至少提供管理摘要。把重点放在管理总结的业务上，把好的技术优势放在你的合作开发者阅读的部分。

Answer 2

与实施不同的要求。我会得到一个初始文档，以捕获系统的“什么”。

文档的网站 - 我使用该状态图。每个页面都是一个状态，每个可能的导航/操作都是一个转换。根据您的确切用户，您可能需要模拟屏幕，以便了解转换。

页和模板的详细设计是有点二次 - 我喜欢把这个回监守它往往是，每个人都希望成为一个设计师的作品。

如果系统的接口还包括外部调用Web服务（或许REST），然后记录它的外部接口的一部分，并需要使用它的人的同意。简单的UML类图或伪代码接口。

将有与这些伪影相关联的“接口数据模型”。数据显示在plages上并由任何公共nservices返回。这可以在您选择的数据建模工具中进行建模（我将使用UML类图）。

设计中的...MVC层和详细的业务逻辑可以使用面向对象技术建模，UML也可以正常工作。

Peristence layer ...取决于数据库/遗留系统是否已经存在。您需要某种数据模型，并且可能需要记录接口数据和Peristed Data之间的映射 - 这可能很简单，也可能需要非常详细的设计。捕获映射数据最好在表格或类似电子表格的工具中完成。

Answer 3

我劝你写了两份文件：

• 一个技术说明：如果在需要时您会写所有的技术性的东西，从数据库结构的协议描述。

• 一个功能描述：从哪里编写所有功能的东西，从项目的目的到应用程序的每个功能的描述。

每个文档都会针对不同的人，其中一些非常擅长技术细节，另一些非常擅长应用程序的可用性。

当我想确定我的技术和功能文档是有用的时候，我会写下他们的想法：“如果我明天去世，我希望阅读这些文档的人以各种方式理解应用程序，并且我希望他们确保如何做到这一点，就像我希望这样做“。我最终最终深入了解应用程序的细节，但通常是一个好主意。我注意到我写这些文档的时间越多，后来获得的电话就越少，而且一旦应用程序进入测试阶段，我就会得到越少的惊喜。

Cliffnotes：两个文档针对两个截然不同的观众。一位技术人员对技术花絮非常感兴趣，另一位对技术花絮毫不了解。花点时间，解释一些事情，制作模式和图表（如果你确定自己擅长这些），一次又一次地阅读你的文档，你就会有一个可靠的文档。

编辑：Word（或任何其他文字处理程序）通常足够制作这种文档。使用UML并不总是一个好主意，尤其是如果你不擅长UML（不要羞愧:)。

我发现一个小技巧很有用：使用所见即所得的网页编辑器可以帮助您制作快速且简洁的页面原型，您可以将其插入到文档中。我甚至在重新安装旧计算机上安装VB6的过程中，为此制作了一个快速而又脏的窗口应用程序原型。它效果很好，所需时间很少。