Программная документация
Любой письменный текст, иллюстрации или видео, которые описывают программное обеспечение или программу для пользователей, называется program or software document. Пользователем может быть любой человек, от программиста, системного аналитика и администратора до конечного пользователя. На разных этапах разработки может быть создано несколько документов для разных пользователей. По факту,software documentation является важным процессом в общем процессе разработки программного обеспечения.
В модульном программировании документация становится еще более важной, потому что разные модули программного обеспечения разрабатываются разными командами. Если кто-то, кроме команды разработчиков, хочет или нуждается в понимании модуля, хорошая и подробная документация облегчит задачу.
Это некоторые рекомендации по созданию документов -
Документация должна быть с точки зрения читателя.
Документ должен быть однозначным
Не должно быть повторений
Следует использовать отраслевые стандарты
Документы всегда нужно обновлять
Любой устаревший документ должен быть исключен из обращения после надлежащей регистрации поэтапного отказа.
Преимущества документации
Вот некоторые из преимуществ предоставления программной документации:
Отслеживает все части программного обеспечения или программы
Техническое обслуживание проще
Программисты кроме разработчика могут понимать все аспекты программного обеспечения
Повышает общее качество программного обеспечения
Помогает в обучении пользователей
Обеспечивает децентрализацию знаний, сокращает затраты и усилия, если люди внезапно покидают систему
Примеры документов
С программным обеспечением может быть связано много типов документов. Некоторые из важных включают в себя -
User manual - В нем описаны инструкции и процедуры для конечных пользователей по использованию различных функций программного обеспечения.
Operational manual - В нем перечислены и описаны все выполняемые операции и их взаимозависимости.
Design Document- Он дает обзор программного обеспечения и подробно описывает элементы дизайна. Он документирует такие детали, какdata flow diagrams, entity relationship diagrams, и т.д.
Requirements Document- В нем есть список всех требований к системе, а также анализ жизнеспособности требований. В нем могут быть пользовательские кейсы, сценарии реальной жизни и т. Д.
Technical Documentation - Это документация реальных программных компонентов, таких как алгоритмы, блок-схемы, программные коды, функциональные модули и т. Д.
Testing Document - Он записывает план тестирования, тестовые примеры, план валидации, план верификации, результаты тестирования и т. Д. Тестирование - это один из этапов разработки программного обеспечения, который требует подробного документирования.
List of Known Bugs- В каждом программном обеспечении есть ошибки или ошибки, которые нельзя удалить, потому что они либо были обнаружены очень поздно, либо безвредны, либо потребуют больше усилий и времени для исправления, чем необходимо. Эти ошибки перечислены в документации к программе, чтобы их можно было удалить позже. Также они помогают пользователям, разработчикам и обслуживающему персоналу, если ошибка активирована.