Как правильно документировать логический поток приложения?

Question

Меня попросили пройти через существующее приложение ASP.NET и «Документировать поток логики» приложения.Будучи студентом и никогда не занимаясь этим раньше, я задаюсь вопросом, какую информацию люди обычно включают в такой документ?

Объяснение, которое мне дали для того, что нужно, было расплывчатым, и я предполагаю, чтоОсновная задача здесь - понять, как работает приложение.

Приложение имеет несколько слоев, которые выглядят примерно так:

Уровень пользовательского интерфейса -> Уровень представления -> Уровень контроллера -> Уровень доступа к данным

Каждый слой имеет логику, которая выполняет различные задачи, поэтому мне нужно будет проходить каждый слой по разделам.

Есть предложения?Неопределенно, я знаю, но я был бы рад уточнить, если требуется.

Answer 1

У Microsoft есть некоторые соглашения и инструменты для встроенной документации.http://msdn.microsoft.com/en-us/library/b2s063f7(v=VS.100).aspx Но это не имеет отношения к потоку.Скорее, как добавить комментарии, которые свернуты.

Answer 2

Вот различные точки зрения, которые являются общими.Вы должны уточнить, а не позже, что они ищут.Вы также можете проявить большую активность, начав с предложения, скажем, с точки зрения компонентов и поведения.Типы (Эти термины удобны для Google / Wiki:

• Поток информации
• Функциональная декомпозиция
• Стек решений / Техническое размещение
• Компонент / Структурный /Класс
• Поведение - последовательность, связь, последовательность операций
• Подробный логический поток (если, затем, для методов и т. Д.)
• Общий обзор / Один пейджер
• Бизнес-логика / Использование / Взаимодействие
• Сеть / Топология

В документации также важно понимать, какова цель.

1. Поделитьсяс деловым партнером?
2. Поделиться с лидером, технический?
3. Это вводный или высокоуровневый взгляд?
4. Кто ваша аудитория?

Вы должны понимать, как должны взаимодействовать конкурирующие читатели: «Краткость», «Нетехнический», «Полный», «Полный», «Точный», «Аспект»

Например: было бы невозможно получить полную, нетехническую, сетевую диаграмму, так какНомера портов и брандмауэры будут потеряныт на них.Или краткое, полное, последовательность операций также будет затруднена.

Резюме: Поэтому хорошим ответом по умолчанию является 1. Создайте краткое описание, если ваша аудитория даже не знает систему.Один абзац для бизнес-функции и один для структуры / компонентов приложения.2. Составьте диаграмму компонентов, включите пакеты и служебные библиотеки и т. Д. 3. Создайте последовательность уровня метода / класса или блок-схему основного пути выполнения.Затем вернитесь к заявителю, спросите, что они ищут, и покажите им, что у вас есть.Предполагая, что заявитель является техническим лидером в некотором роде.Без подробностей эта рекомендация в лучшем случае грубая.

Answer 3

Вы описываете программное обеспечение или стек решений.Начните здесь:

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

Если вам нужно быть более конкретным в своей документации, выберите каждый метод в вашем решении, а затем «Просмотр иерархии вызовов».Это покажет, какие вызовы сделаны из каждого метода, и вы можете задокументировать это.Вы также можете использовать «Обозреватель объектов» VS.