Документация принадлежит к типу программно-эксплуатационной. Объединяет в себе пакеты документов по программе, комплексу и программным компонентам системы или комплекса. Создается для людей, от которых зависит принятие решения о покупке, настройке и вариантах применения программы. Все документы соответствуют стандартам 19.402-78 и 19.502-78.
Предмет и назначение
Персонал, соприкасающийся в своей работе с программой, подразделяется на тех, кто с ней работает (пользователи, администраторы, операторы и т.д.) и тех, от кого зависит принятие решения по ее покупке и использованию (ведущие специалисты, менеджеры и т.д.). Специалисты в полной мере владеют информацией о возможностях программы и ее функционале. Эти сведения они получают из документации: описание программы и ее применение.
1. Цель программы, ее функциональные возможности;
2. Требуемые ресурсы для эксплуатации;
3. Вводимая информация;
4. Выходные сведения.
При описании программы текст максимально подробный, применение же описывается структурно.
Как работать с виртуальной доской Miro. Обзор основных возможностей.
Методология и язык написания
Не принципиальные подробности в данных документах не допустимы, т.к. они не дают пользователю понять главную суть документа. Акцент делается на перечне задач, решаемых при помощи данной программы и средствах их решения.
Стандартная структура — согласно ГОСТ 19.402-78.
1. Общие сведения.
2. Функциональное назначение.
3. Описание логической структуры.
4. Применяемые технические устройства.
5. Вызов и загрузка.
6. Входные данные.
7. Выходные данные.
Стандартная структура — согласно ГОСТ 19.502-78.
1. Назначение программы.
2. Условия применения.
3. Описание задачи.
4. Входные и выходные данные.
Источник: tehpis.ru
Описание применения
Текст раздела Описание применения должен состоять из следующих подразделов:
входные и выходные данные.
В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные подразделы.
В подразделе “Назначение программы” указывают назначение, возможности программы, ее основные характеристики, ограничения, накладываемые на область применения программы.
В подразделе “Условия применения” указывают условия, необходимые для выполнения программы (требования к необходимым для данной программы техническим средствам, и другим программам, общие характеристики входной и выходной информации, а также требования и условия организационного, технического и технологического характера и т.п.).
В подразделе “Описание задачи” должны быть указаны определения задачи и методы ее решения.
В подразделе “Входные и выходные данные” должны быть указаны сведения о входных и выходных данных.
Руководство системного программиста
Текст раздела Руководство системного программиста должен содержать следующие подразделы:
Возможности и применение After Effects.
общие сведения о программе;
сообщения системному программисту.
В зависимости от особенностей программы допускается объединять отдельные подразделы или вводить новые.
В обоснованных случаях допускается подраздел “Дополнительные возможности” не приводить, а в наименованиях подразделов опускать слово “программа” или заменять его на “наименование программы”.
В подразделе “Общие сведения о программе” должны быть указаны назначение и функции программы и сведения о технических и программных средствах, обеспечивающих выполнение данной программы.
В подразделе “Структура программы” должны быть приведены сведения о структуре программы, ее составных частях, о связях между составными частями и о связях с другими программами.
В подразделе “Настройка программы” должно быть приведено описание действий по настройке программы на условия конкретного применения (настройка на состав технических средств, выбор функций и др.). При необходимости приводят поясняющие примеры.
В подразделе “Проверка программы” должно быть приведено описание способов проверки, позволяющих дать общее заключение о работоспособности программы (контрольные примеры, методы прогона, результаты).
В подразделе “Дополнительные возможности” должно быть приведено описание дополнительных разделов функциональных возможностей программы и способов их выбора.
В подразделе “Сообщения системному программисту” должны быть указаны тексты сообщений, выдаваемых в ходе выполнения настройки, проверки программы, а также в ходе выполнения программы, описание их содержания и действий, которые необходимо предпринять по этим сообщениям.
В разделе к руководству системного программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
Руководство программиста
Раздел Руководство программиста должен содержать следующие подразделы:
назначение и условия применения программы;
входные и выходные данные;
В зависимости от особенностей ПЗ допускается объединять отдельные разделы или вводить новые.
В подразделе “Назначение и условия применение программы” должны быть указаны назначение и функции, выполняемые программой, условия, необходимые для выполнения программы (объем оперативной памяти, требования к составу и параметрам периферийных устройств, требованию к программному обеспечению и т.п.).
В подразделе “Обращение к программе” должно быть приведено описание процедур вызова программы (способы передачи управления и параметров данных и др.).
В подразделе “Входные и выходные данные” должно быть приведено описание организации используемой входной и выходной информации и, при необходимости ее кодирования.
В подразделе “Сообщения” должны быть указаны тексты сообщений, выдаваемых программисту или оператору в ходе выполнения программы, описание их содержания и действия, которые необходимо принять по этим сообщениям.
В разделе к руководству программиста могут быть приведены дополнительные материалы (примеры, иллюстрации, таблицы, графики и т.п.).
Источник: studfile.net