Как правильно описать архитектуру проекта?

Question

[Ivan Stroykin]

Доброго времени суток,

понадобилось описать архитектуру проекта, основные узлы (модули), что с чем взаимодействует (потоки данных), используемые СУБД. Ранее не занимался подобным и не могу понять, по какому принципу правильнее будет описывать..
Можете подтолкнуть в правильную сторону? Желательно на какой-нибудь пример
Из используемого:: python + django, golang, angular, postgresql, redis и еще некоторые

Comments

[pi314]

www.ecs.csun.edu/~rlingard/COMP684/Example2SoftArch.htm
https://www.dropbox.com/s/gbhqw9ieysodpu7/arc42-te...

[Ivan Stroykin]

pi314: Напишите ниже. Чтобы была возможность отметить вас

[pi314]

Иван Стройкин: Рад, если ссылки оказались полезны, но я не гонюсь за славой, а написать обстоятельный ответ, чтоб был полезен еще кому-то, к сожалению, просто не было времени. Так что, пускай остается, в комментах )) Добавлю только, что ARC42 в той или иной форме используется для документирования больших проектов, разрабатываемых под кучей норм и регуляций, причем, как водопадно, так и агильно. (В моем текущем проекте это документ под тысячу страниц с тоннами UML и сквозными requirement и risk traceability). Но он хорош также и тем, что его можно сокращать до разумного минимума без потери смысла, т.к. он задает только общие рамки - какие аспекты нужно раскрыть в документе, а уже сколько и как детально написать на каждую тему, оставляет полностью на откуп архитектору.

[Ivan Stroykin]

pi314: Премного благодарен за ответ. Но всё же было бы хорошо написать его ниже, чтобы я его так же выбрал, не ради славы, а ради других пользователей, которые ищут ответ по подобному вопросу, и которые будут рады увидеть данный ответ. Мало кто умудряется прочитать комментарии )

Answer 1

[developer007]

Вот пару примеров из курса проектирования АСОИУ https://yadi.sk/i/KTRP6OeI38NmZZ

погуглите ПРОЕКТИРОВАНИЕ АСОИУ - я не помню как нотации называются ....IDEF0 и прочие



погуглите еще - " Диаграмма классов, Диаграмма развертывания

для построения диаграмм я использовал enterprise architect
или draw.io

стили отличаются.

Comments

[Ivan Stroykin]

Использую как раз draw.io. Спасибо. Сейчас начал с UML и bpmn. Сразу видно как что работает. удобно

Answer 2

[Виктор]

Можете взять за основу ГОСТ 34 (www.rugost.com/index.php?option=com_content&view=a...
Минимальный набор документов обычно:
1. Пояснительная записка ( в ней содержаться описаний основных проектных решений (фреймворков, модулей, классов и тд)
2. Схема функциональной структуры (отражает взаимосвязи компонентов системы)
3. Описание организации информационной базы (описание БД, таблиц, хранимых процедур и тд)
4. Перечень входных сигналов и данных (какие данные и в каком формате принимает система)
5. Схема структурная комплекса технических средств (на каких серверах какие компоненты размещаются и какими сетями соединены)
6. Руководство пользователя
7. Таблица соединений и подключений (по сути схема коммутации)
8. Схема структурная комплекса технических средств (взаимосвязи серверов )
9. Технологическая инструкция (регламент обслуживания системы)

Либо посмотреть в сторону ISO (не помню номер стандарта - называется software description)

Answer 3

[malbaron]

Исходя из обычного здравого смысла.
Там нет ничего такого особенно волшебного.

P.S.:
Есть специальные инструменты, есть специальные языки описания проектов - но это уже для серьезных задач.
Сомневаюсь, что серьезная задача вдруг оказалась на плечах человека, который не знает как к ней подойти.

Comments

[big_hasan]

malbaron : Не могли ли бы Вы привести пару примеров этих самых языков описания проектов?