如何正确记录应用程序的逻辑流程？

Question

我被要求通过现有的ASP.NET应用程序和“记录应用程序的逻辑流程”。作为一名学生，以前从未这样做过，我想知道人们通常会在这样的文件中包含哪些信息？

我所获得的解释是模糊的，我认为这里的主要目标是让我理解应用程序的工作原理。

该应用程序有多个层次，大致如此：

UI图层 - ＆gt;表示层 - ＆gt;控制器层 - ＆gt;数据访问层

每一层都有完成各种任务的逻辑，所以我需要逐节遍历每一层。

有什么建议吗？我知道含糊不清，但如果需要，我很乐意澄清。

Answer 1

您正在描述软件或解决方案堆栈。从这里开始：

http://en.wikipedia.org/wiki/Solution_stack

如果您需要在文档中更具体，请选择解决方案中的每个方法，然后选择“查看调用层次结构”。这将显示从每个方法进行的调用，并且您可以记录该调用。您还可以使用VS的“对象浏览器”。

Answer 2

Microsoft提供了一些内联文档的约定和工具。 http://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx 但这并不真正涉及流量。而是如何添加汇总的评论。

Answer 3

以下是不同的观点。你应该尽早澄清他们正在寻找的东西。通过从提案开始，比如组件和行为视角，您也可以听起来更积极主动。 类型（这些术语是谷歌/维基友好：

• 信息流
• 功能分解
• 解决方案堆栈/技术放置
• 组件/结构/类
• 行为 - 序列，沟通，流程
• 详细的逻辑流程（if，then，for，methods等？）
• 概述/一个寻呼机
• 业务逻辑/使用/互动
• 网络/拓扑结构

在文档中，了解目标是至关重要的。

1. 与商业伙伴分享？
2. 与领导者分享技术？
3. 是介绍性还是高级别的观点？
4. 您的受众群体是谁？

你必须了解竞争读者需要如何互动，简洁与非技术对比完全对比准确与方面

例如：由于端口号和防火墙将丢失，因此无法拥有完整的非技术性网络图。或简单，完整的流程也很困难。

摘要：一个好的默认答案是1.如果您的受众甚至不了解系统，请创建摘要说明。一个用于业务功能的段落和一个用于应用程序结构/组件的段落。 2.执行组件图，包括包和实用程序库等.3。创建主要执行路径的方法/类级别序列或流程图。然后回到请求者，询问他们正在寻找什么，并向他们展示你到目前为止所拥有的。假设请求者是某种技术领导者。没有更多细节，这个建议充其量是粗糙的。​​