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