Учебники

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

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

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

Вот некоторые рекомендации по созданию документов –

  • Документация должна быть с точки зрения читателя

  • Документ должен быть однозначным

  • Там не должно быть повторений

  • Промышленные стандарты должны быть использованы

  • Документы всегда должны быть обновлены

  • Любой устаревший документ должен быть снят с производства после надлежащей регистрации

Документация должна быть с точки зрения читателя

Документ должен быть однозначным

Там не должно быть повторений

Промышленные стандарты должны быть использованы

Документы всегда должны быть обновлены

Любой устаревший документ должен быть снят с производства после надлежащей регистрации

Преимущества документации

Вот некоторые из преимуществ предоставления программной документации –

  • Отслеживает все части программного обеспечения или программы

  • Обслуживание проще

  • Программисты, кроме разработчика, могут понимать все аспекты программного обеспечения

  • Улучшает общее качество программного обеспечения

  • Помогает в обучении пользователей

  • Обеспечивает децентрализацию знаний, сокращая затраты и усилия, если люди внезапно покидают систему

Отслеживает все части программного обеспечения или программы

Обслуживание проще

Программисты, кроме разработчика, могут понимать все аспекты программного обеспечения

Улучшает общее качество программного обеспечения

Помогает в обучении пользователей

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

Примеры документов

Программное обеспечение может иметь много типов документов, связанных с ним. Некоторые из важных включают в себя –

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

Руководство по эксплуатации – в нем перечислены и описаны все выполняемые операции и их взаимозависимости.

Проектный документ – он дает обзор программного обеспечения и подробно описывает элементы дизайна. Он документирует такие детали, как диаграммы потоков данных, диаграммы отношений сущностей и т. Д.

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

Техническая документация – это документация о реальных компонентах программирования, таких как алгоритмы, блок-схемы, программные коды, функциональные модули и т. Д.

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

Список известных ошибок – У каждого программного обеспечения есть ошибки или ошибки, которые нельзя удалить, потому что они были обнаружены слишком поздно или безвредны или потребуют больше усилий и времени, чем необходимо для исправления. Эти ошибки перечислены вместе с программной документацией, так что они могут быть удалены позже. Также они помогают пользователям, разработчикам и специалистам по обслуживанию, если ошибка активирована.