На ваш вопрос нет однозначного ответа, ведь создание полезных диаграмм во многом зависит от того, какую информацию вы хотите донести до читателя. Мой совет: вы никогда не сможете показать все функциональные возможности вашей программы только на одной диаграмме; обработка событий часто бывает слишком сложной и уродливой — попробуйте разбить ее на более мелкие части и решить индивидуально, какая диаграмма полезна для каких аспектов, которые вы хотите показать.
В каждом из них ваше внимание всегда должно быть сосредоточено на читателе: что вы хотите, чтобы он или она поняли?
Для начала обычно лучше написать пользовательские истории и показать варианты использования, если у вас их еще нет. Они передают функциональность, для которой была создана ваша программа, и помогают вам идентифицировать процессы и организовать то, как вы думаете о своей программе. Для каждого из этих процессов диаграмма последовательности, вероятно, наиболее полезна, чтобы показать, как все работает. Например, если одной из функций вашей программы является загрузка изображения, вам следует нарисовать диаграмму последовательности, показывающую основные компоненты, объекты и последовательности событий, участвующих только в процедуре загрузки.
Следующим шагом является категоризация оставшихся событий и объектов, которые более детализированы или не взаимодействуют напрямую с пользователем: какие события являются внутренними (т. е. отправляются и обрабатываются внутри одного и того же объекта), какие являются внешними (между некоторыми объектами). или даже глобальные (влияющие на все приложение). Это поможет вам идентифицировать группы объектов, взаимодействующих друг с другом.
В зависимости от того, насколько сложен объект, я часто отображаю последовательности внутренних событий в виде диаграммы состояний или блок-схемы.
Если у вас есть небольшие группы объектов, где взаимодействия не слишком сложны и более интересны с точки зрения того, кто что делает, почему вместо когда, вы можете использовать слегка измененные диаграммы классов. - они могут быть не очень формальными, но для некоторых понятий они часто более полезны, чем блок-схемы, диаграммы состояний или последовательности.
Следует также отметить, что в некоторых случаях диаграмма вообще не помогает. Иногда гораздо полезнее написать короткий текст с примером или собрать информацию в виде таблиц. Документация завершена, когда читатель понимает концепцию того, что делает ваша программа и как она это делает. Для всего остального всегда есть исходный код.
person
weltraumpirat
schedule
07.01.2011
