Перечень входных сигналов и данных

2.6.1. Документ должен состоять из следующих разделов:

• перечень входных сигналов;
• перечень входных данных.

2.6.2. Требования к содержанию разделов

2.6.2.1. В разделе «Перечень входных сигналов» должны быть приведены:

• для каждого аналогового сигнала - наименование измеряемой величины, единицы измерения, диапазон изменения, требования к точности и периодичности измерения, тип сигнала;
• для каждого дискретного сигнала - наименование, разрядность и периодичность, тип сигнала;
• для каждого сигнала типа «да-нет» о наличии или отсутствии некоторого события - указание источника формирования.

2.6.2.2. В разделе «Перечень входных данных» должны быть приведены входные данные с указанием их наименований, кодовых обозначений и значности реквизитов, а также наименования и кодовые обозначения документов или сообщений, содержащих эти данные.

2.7. Перечень выходных сигналов (документов)

2.7.1. Документ должен состоять из следующих разделов:

• перечень выходных сигналов;
• перечень выходных документов.

2.7.2. Требования к содержанию разделов

2.7.2.1. В разделе «Перечень выходных сигналов» должен быть приведен перечень выходных сигналов с указанием их наименований, назначения единиц измерения и диапазонов изменения, способа представления, пользователей информации.

2.7.2.2. В разделе «Перечень выходных документов» должен быть приведен перечень выходных документов с указанием их наименований, кодовых обозначений, перечня и значности реквизитов, пользователей информации.

Описание технологического процесса обработки данных

2.8.1. Документ должен состоять из следующих разделов:

• технологический процесс сбора и обработки данных;
• технологический процесс обработки данных на ВЦ;

2.8.2. Требования к содержанию разделов

2.8.2.1. В разделе «Технологический процесс сбора и обработки данных» должны быть приведены:

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

2.8.2.2. В разделе «Технологический процесс обработки данных на ВЦ» должны быть приведены:

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

 

Документация на программное обеспечение

Документация на программное обеспечение — печатные руководства пользователя, диалоговая (оперативная) документация и справочный текст, описывающие, как пользоваться программным продуктом.

Существует четыре основных типа документации на ПО:

- архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО;
- техническая — документация на код, алгоритмы, интерфейсы, API;
- пользовательская — руководства для конечных пользователей, администраторов системы и другого персонала;
- маркетинговая

Архитектурная/проектная документация

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

Техническая документация

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

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

Часто при составлении технической документации используются автоматизированные средства — генераторы документации, такие как Doxygen, javadoc, NDoc и другие. Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML.

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