Файл: Разработка структуры электронного варианта документации.docx
ВУЗ: Не указан
Категория: Не указан
Дисциплина: Не указана
Добавлен: 06.12.2023
Просмотров: 28
Скачиваний: 1
ВНИМАНИЕ! Если данный файл нарушает Ваши авторские права, то обязательно сообщите нам.
Учебное занятие № 27
Тема: Разработка структуры электронного варианта документации
Тип учебного занятия: выработка и закрепление умений и навыков.
Вид учебного занятия: учебная практика
Время выполнения: 6 часов
ПОСЛЕДОВАТЕЛЬНОСТЬ ВЫПОЛНЕНИЯ РАБОТЫ:
МЕТОДИЧЕСКИЕ УКАЗАНИЯ
Определение
Документация- печатный текст, сопровождающий программное обеспечение для объяснения принципов его функционирования или использования.
Цели документирования:
▶ посредничество между разработчиками ПО;
▶ упрощение сопровождения и эволюции;
▶ информация для планирования и оценки затрат в процессе разработки;
▶ инструкции по использованию и управлению программной системой;
▶ основание для сертификации системы.
Типы документации
Документация на процесс разработки (англ. process documentation):
▶ планы разработки;
▶ расписания;
▶ документы оценки качества процессов разработки;
▶ организационные и проектные стандарты.
Документация на продукты разработки (англ. product documentation):
▶ системная (техническая) документация описание программной системы с точки зрения разработчика;
▶ пользовательская документация описание ПО с точки зрения конечного пользователя.
Документация в гибкой методологии
Работающее ПО > Исчерпывающая документация Agile Manifesto
Недостатки традиционного подхода к документированию:
▶ Производство документации и поддержка документов в актуальном состоянии занимает много времени и средств и приводит к замедлению процесса разработки.
▶ Требования к ПО меняются настолько быстро, что документация устаревает практически сразу после написания.
Необходимые виды документации:
▶ пользовательская документация
;
▶ обоснование архитектурных решений;
▶ документация критических систем.
Структура документации на ПО:
1. данные, позволяющие идентифицировать документ (заголовок, дата составления и т. п.);
2. содержание;
3. список иллюстраций и таблиц (опционально);
4. введение назначение документа и краткое описание содержимого;
5. информация по использованию советы по эффективному использованию различными группами пользователей (новичками, опытными пользователями, администраторами, …);
6. концепция ПО описание вариантов использования программной системы;
7. команды описание команд, поддерживаемых системой;
8. выдаваемые программой сообщения об ошибках и способы их устранения;
9. словарь используемых в документе специфичных терминов;
. связанные документы и информационные ресурсы;
11. навигация (особенно для электронных документов);
12. алфавитный указатель по командам;
13. поиск по содержанию (для электронных документов).
Форматы документации
Электронная документация:
▶ локальные файлы (plain text, Markdown, HTML, PDF, …);
▶ интегрируемая в общесистемную справочную систему (man, info, …);
▶ интегрируемая в среду разработки (напр., исходные Java-файлы или javadoc-архивы при разработке на Java в Eclipse).
Задание: Разработать структуры документации разработанного программного обеспечения в электронном варианте.