Справочник программиста в стихах. От проектирования до внедрения

Статическая диаграмма

Структуры кода и системы –

Пожалуй, диаграмма классов,

Одна из главных в Юмээле.

На ней показывают классы,

Их методы и атрибуты.

И связи между ними сразу

Здесь тоже есть в их общей сути.

Диаграмма прецедентов (Use case diagram)

На диаграмме прецедентов

Показывают отношения –

Связи от юзеров системы

К ее вариантам выполнения.

Диаграмма последовательности (Sequence diagram)

Взаимодействие объектов

Показывают диаграммой

Последовательности выполнения.

На ней представлены программа

И пользователь, и другие

Участники, как вертикали.

И сообщения между ними

По времени их протекания.

Диаграмма компонентов (Component diagram)

На диаграмме компонентов

Показаны библиотеки,

Модули, файлы и пакеты

И связи между ними всеми.

Диаграмма развёртывания/размещения (Deployment diagram)

На диаграмме размещения

Показывают наложение

Программного обеспечения

На аппаратные решения.

Глава 7. Техническая документация

Техническое задание³

Для выполнения проекта

С известным качеством и сроком

Весьма полезным документом

ТЗ является. Во многом

Его задача – однозначность

При понимании системы.

В ТЗ описаны задачи

Проекта так, чтоб были всеми

Они восприняты в едином

Ключе и смысле, и трактовок

Различных не было в картине

И описании разработок.

Частное техническое задание

Когда проект большой ведётся,

И разработчиков в нём много,

На подсистемы создаётся

Задание частное в итоге.

Технический проект⁴

Все описания дальнейших

Проектных принятых решений

Технический проект содержит,

В нём излагают о системе

Устройство, алгоритмы, схемы,

От базы данных до внедрения

И эффективности системы.

На языке для исполнения:

Когда ТЗ для всех понятно,

ТП – уже для программиста –

В нём не столь нужно деликатно

Искоренять все жаргонизмы.

Руководство пользователя

Когда написана система,

Для помощи в работе с нею

Полезна текстовая схема,

Чтоб описать её идею

Для пользователей и просто

Помочь в процессе изучения

Её работы – руководство.

Обычно в нем обозначение

Дается следующим вопросам:

Обзор и ссылки, назначение

Системы, функции и способ

Их применения, и решение

Проблем возможных при работе

И при типичном применении.

Полезный документ для многих,

При изучении приложения.

Руководство администратора

Администратору в работе

Инструкция нужна другая –

В ней описание даёте

Как доступ, роли назначают,

Как заполняют базы данных

И разворачивают сервер,

Как исправлять ошибки надо,

Коль есть известные примерно.

Программа и методика испытаний⁵

Когда проект идёт к внедрению,

Бывает нужен документ,

В котором есть определение,

Как «тестить» каждый элемент.

Программа тестов-испытаний

При разработке под заказ

Даёт возможность понимания,

Что как проверить и, подчас,

Нужна не менее задания

На разработку, ведь по ней

Проводится согласование

С заказчиком системы всей.

В ней нужен список всех условий

Для выполнения работ,

Сценарий, тесты, по которым

Заказчик проверять пойдёт.

Часть 2. Архитектура ПО

Архитектура

Архитектура приложения –

Борьба со сложностями в нём.

И без неё, как наваждение,

Затраты потекут ручьём,

Потом безудержным потоком

На проведение небольших,

Казалось бы, работ. Итогом –

Перерасход сил трудовых.

Программная архитектура –

Есть описание частей

Системы – вся её структура,

Устройство, отношения в ней –

Все те решения, что в дальнейшем

Затратно будет изменять.

Поэтому вопрос важнейший

Их, в целом, правильно принять.

Хорошая архитектура

Даёт возможность широко

Сопровождения процедуру

Вести удобно и легко.

Вся суть здесь в разделении кода

На модули и компоненты.

С таким предположением, чтобы

Ослабить связи элементов.

Охватить проект единой мыслью?

Память нужна программисту для жизни,

Больше, пожалуй, чем многим другим.