29. Поддержка программиста: общие требования

Программу для потенциальных пользователей-программистов следует выполнять (в целях её совершенствования или адаптации) максимально просто и понятно (а также соблюдая приёмы рефакторинга). Для этого её надо тщательно спроектировать, закодировать, представить в удобной для понимания форме и снабдить документацией в необходимом объёме. Каждый модуль программы должен быть по возможности аккуратно и без излишеств самодокументирован.

29.1. Пролог модуля

Кодирование модуля должно начинаться с его общего описания – так называемого «пролога». Пролог обычно включает в себя следующие элементы:

1. Номер и имя модуля.

2. Фамилию программиста, дату завершения работы над модулем и номер его версии.

3. Функциональное описание модуля.

4. Перечень основных используемых алгоритмов со ссылками.

5. Словарь данных для параметров.

6. Имена подпрограмм, вызывающих (использующих) модуль.

7. Имена подпрограмм, вызываемых (используемых) модулем.

8. Словарь данных для разделяемых областей хранения данных

9. Словарь данных для внутренних (разделяемых) данных.

10. Описание ввода-вывода.

11. Описание исключений модуля и процесса обработки ошибок, выполняемого модулем.

Пролог целесообразно включать в исходный текст модуля в виде комментария. В мнемонических конструкциях целесообразно применять венгерскую нотацию.

29.2. Проектная документация

Проектная документация обычно включает в себя следующие элементы:

1. Перечень важнейших функций, реализуемых системой.

2. Определения потоков данных.

3. Графические описания процессов передачи данных и управления.

4. Перечень носителей информации, используемых для хранения.

5. Описание средств взаимодействия с вычислительной средой (включая списки уже имеющихся наборов данных и программ).

6. Перечень имён наборов данных и программ, подлежащих разработке.

7. Требования к синхронизации выполняемых операций с учётом доступности данных.

8. Предложения по разработке системных средств защиты.

9. Перечень контрольных примеров для проверки всех элементов системы с приведением ожидаемых результатов.

29.3. Оформление текста программы

Текст программы воспринимается лучше, если он удачно располагается на странице, выделены поля, строки не перегружены информацией использованы отступы и пробелы. Для всего этого полезны следующие приёмы оформления:

1. Оставлять между основными частями программы 3 пустых строки, между не основными – 2, а после каждой последовательно выполняющейся группы операторов – 1 пустую строку.

2. Использовать базовые управляющие структуры (следование, ветвление цикл).

3. Соблюдать абзацный отступ в 2÷5 пробелов для тел циклов и подчинённых операторов.

4. Широко применять комментарии.

5. Помнить, что объявления переменных, и комментарии составляют вместе с прологом документацию программы.

30. Поддержка конечного пользователя

Начальный этап. Основа – предоставление информации о будущем продукте. При этом реклама должна быть деловой и ориентированной на конкретного потребителя, учитывающей основные положения менеджмента.

Развитое применение программы. При развёрнутом выпуске и использовании программы в работу с ней подключается всё более широкий круг людей. Многие из них могут использовать опыт тех, кто начал работу с программой ранее и не испытывает существенных, принципиальных трудностей. Однако не все имеют такую возможность. Кроме того, всегда и в первую очередь надо обеспечивать работу тех, кто начинает впервые. Для таких лиц надо предусмотреть весь спектр поддержки. С точки зрения технической организации интерфейса к основным видам поддержки пользователей следует отнести следующие:

• экранная помощь;

• хинты;

• статусные строки;

• учебники;

• документация к программе в комплекте.

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