Любой письменный текст, иллюстрации или видео, которые описывают программное обеспечение или программу для его пользователей, называется программным или программным документом. Пользователь может быть любым от программиста, системного аналитика, администратора до конечного пользователя. На разных этапах разработки для разных пользователей могут создаваться несколько документов. Фактически, документация по программному обеспечению является критическим процессом в общем процессе разработки программного обеспечения.
В модульной документации по программированию становится еще более важным, поскольку разные модули программного обеспечения разрабатываются различными командами. Если кто-либо, кроме команды разработчиков, хочет или должен понять модуль, хорошая и подробная документация облегчит задачу.
Это некоторые рекомендации по созданию документов:
Документация должна быть с точки зрения читателя
Документ должен быть однозначным
Не должно быть повторений
Следует использовать отраслевые стандарты
Документы всегда должны обновляться
Любой устаревший документ следует поэтапно прекратить после надлежащей регистрации поэтапного отказа
Преимущества документации
Вот некоторые из преимуществ предоставления программной документации:
Отслеживает все части программного обеспечения или программы
Упрощение обслуживания
Программисты, кроме разработчика, могут понять все аспекты программного обеспечения
Улучшает общее качество программного обеспечения
Помогает в обучении пользователей
Обеспечивает децентрализацию знаний, сокращение затрат и усилий, если люди внезапно покинут систему
Примеры документов
У программного обеспечения может быть много типов связанных с ним документов. Некоторые из важных включают:
Руководство пользователя. В нем описываются инструкции и процедуры для конечных пользователей, которые используют различные функции программного обеспечения.
Операционное руководство. В нем перечислены и описаны все выполняемые операции и их взаимозависимости.
Проектный документ. Он дает обзор программного обеспечения и подробно описывает элементы дизайна. Он документирует детали, такие как диаграммы потоков данных, диаграммы связей сущностей и т. д.
Документ требований. Он содержит список всех требований системы, а также анализ жизнеспособности требований. Он может иметь пользовательские случаи, реальные сценарии и т. д.
Техническая документация. Это документация по актуальным компонентам программирования, таким как алгоритмы, блок-схемы, программные коды, функциональные модули и т. д.
Тестирующий документ. Он записывает план тестирования, тестовые примеры, план проверки, результаты тестирования и т. д. Тестирование – это один этап разработки программного обеспечения, требующий интенсивной документации.
Список известных ошибок. У каждого программного обеспечения есть ошибки или недочеты, которые невозможно удалить, поскольку они были обнаружены очень поздно или безвредны или потребуют больше усилий и времени, чем это необходимо для исправления. Эти ошибки перечислены в документации по программам, чтобы их можно было удалить позднее. Также они помогают пользователям, исполнителям и обслуживающим людям, если ошибка активна.
Если вы нашли ошибку, пожалуйста, выделите фрагмент текста и нажмите Ctrl+Enter.
Если статья понравилась, то поделитесь ей в социальных сетях:
Загрузка...
