Оформление программы по госту (how to). Описание структуры программы Описание программы гост 19.402 78 пример документа

Большинство сайтов, особенно на бесплатном хостинге , не хранит «крупную» информацию вроде фильмов, музыки и игр на своем дисковом пространстве. На сайте находятся только ссылки с описаниями ресурсов, за скачивание которых владелец сайта часто получает награду в виде оплаты.

Чтобы эта награда происходила чаще, требуется немалая фантазия в плане описания ресурса, и главная задача описания - привлечь пользователя , выделяя данное описание из тысячи подобных.

К примеру, очень важны правильные описания фильмов, которые вот-вот должны выйти. Некоторым веб-мастерам кажется, что у них налажен подход к такой проблеме: имеется видеопроигрыватель на сайте , ссылка на известный тизер, описание фильма и его технические данные.

Но, если разобраться, то окажется, что тизер не содержит русского перевода, описание переведено Google-переводчиком из базы IMDB, а технические данные вообще скопированы с чужих сайтов. Да и много ли интереса проявит зритель, глядя на описание в 1-2 строчки? Тут требуется более основательная работа.

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

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

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

• Как точно называется программа .
• Кто ее автор.
• Была ли эта программа раньше известна под другим названием.
• Платная она или бесплатная.
• Точные ограничения бесплатной версии.
• Отличие данной версии от предыдущей.
• Реальные отзывы и проблемы, связанные с программой.
• Скриншоты программы.
• Системные требования (минимальные, обычные и рекомендуемые).
• Особенности установки.
• Объем дистрибутива, размер установленного приложения.
• Наличие русификации (встроенная, внешняя). Русифицирована ли справочная система, имеется ли русскоязычный форум поддержки, можно ли писать в службу поддержки на русском языке. К примеру, тот же Avast уже воспринимается как российская программа, но общение с разработчиками строится только на базе английского языка.
• Какие дополнительные аддоны и дополнения могут потребоваться пользователю при работе с программой.
• Существуют ли конфликты с операционной системой или иным установленным программным обеспечением (брэндмауэры, утилиты оптимизации и безопасности, антивирусы и т.д.).
• Нуждается ли программа при установке и работе в доступе к Интернету. Тоже важный пункт, так как многие программы работают через систему малопонятных загрузчиков, навязывают менеджеры загрузки и т.д.

Чем больше вариантов описания вы предусмотрите, тем больше внимания привлечете к своему ресурсу, а это как раз то, что требовалось.

Предыдущие публикации:

Данный документ относится к типу программно-эксплуатационной. Применяется к программе, комплексу, ПАК, программному компоненту или системе.
Целевая аудитория: лица, которые принимают решение о покупке и вводе в эксплуатацию программы. Документ содержит информацию о функциональных возможностях программы и сфере её применения.

ГОСТы и стандарты

Структуру и оформление документа определяется в .
Информационная часть (аннотации и содержания) в соответствии с .

В каких случаях необходим

Документ необходим для информирования потенциальных пользователей и покупателей о назначении программы и способах применения. Больше подходит для менеджеров (специалистов, системных администраторов), которые самостоятельно принимают решение о приобретении программы и вводе её в эксплуатацию.

Всю необходимую информацию они смогут получить из этого документа: описание программы и ее применение.

В описании программы и описании применения указываются:

Задачи, которые решает программа;
Затрачиваемые ресурсы для работы;
Вводная информация;
Выходные данные.

Акцент делается на описательной части программы, её функциях и назначении. В меньшей степени на описании применения. Делается описание именно о возможностях программы и задач, которая она решает, а не её внутреннего устройства. При определённых особенностях программы допускается объединять разделы или вводить новые (дополнительные).

Структура описания программы (ГОСТ 19.402-78):

1. Общие сведения.
2. Функциональное назначение программы.
3. Описание логической структуры.
4. Технические средства, которые используются.
5. Вызов и загрузка.
6. Входные данные.
7. Выходные данные.

Структура описания применения (ГОСТ 19.502-78):

1. Назначение программы.
2. Условия применения.
3. Описательная часть задачи.
4. Входные и выходные данные.
5. приложения (таблицы, иллюстрации и т.д.).

Вы можете заказать разработку документа или полного комплекта документации на программное обеспечение.

Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен

с 01.01. 1980 г.

1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Описание программы», определённого ГОСТ 19.101-77 .

Стандарт полностью соответствует СТ СЭВ 2092-80.

2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотации и содержания) является обязательным.

3. Описание программы должно содержать следующие разделы:

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

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

4. В разделе «Общие сведения» должны быть указаны:

• обозначение и наименование программы;
• программное обеспечение, необходимое для функционирование программы;
• языки программирования, на которых написана программа.

5. В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.

6. В разделе «Описание логической структуры» должны быть указаны:

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

Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

3-6.(Измененная редакция, Изм. № 1).

7. В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы.

• способ вызова программы с соответствующего носителя данных;
• входные точки в программу.

Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.

9. В разделе «Входные данные» должны быть указаны:

• характер, организация и предварительная подготовка входных данных;
• формат, описание и способ кодирования входных данных.

10. В разделе «Выходные данные» должны быть указаны:

• характер и организация выходных данных;
• формат, описание и способ кодирования выходных данных.

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

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

7-12.(Введены дополнительно, Изм. № 1).

* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)

ГОСТ 19.402-78

Группа Т55

МЕЖГОСУДАРСТВЕННЫЙ СТАНДАРТ

Единая система программной документации

ОПИСАНИЕ ПРОГРАММЫ

Unified system for program documentation. Program description.

МКС 35.080

Дата введения 1980-01-01

Постановлением Государственного комитета CCCР по стандартам от 18 декабря 1978 г. N 3350 дата введения установлена 01.01.80

ИЗДАНИЕ (январь 2010 г.) с Изменением N 1, утвержденным в сентябре 1981 г. (ИУС 11-81).

1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа "Описание программы", определенного ГОСТ 19.101-77 .

Стандарт полностью соответствует СТ СЭВ 2092-80*.
________________
* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей . - Примечание изготовителя базы данных.

(Измененная редакция, Изм. N 1).

2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотации и содержания) является обязательным.

3. Описание программы должно содержать следующие разделы:

общие сведения;

функциональное назначение;

описание логической структуры;

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

входные данные;

выходные данные.

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

4. В разделе "Общие сведения" должны быть указаны:

обозначение и наименование программы;

программное обеспечение, необходимое для функционирования программы;

языки программирования, на которых написана программа.

5. В разделе "Функциональное назначение" должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.

6. В разделе "Описание логической структуры" должны быть указаны:

алгоритм программы;

используемые методы;

структура программы с описанием функций составных частей и связи между ними;

связи программы с другими программами.

Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

3-6. (Измененная редакция, Изм. N 1).

7. В разделе "Используемые технические средства" должны быть указаны типы электронных вычислительных машин и устройств, которые используются при работе программы.

способ вызова программы с соответствующего носителя данных;

входные точки в программу.

Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.

9. В разделе "Входные данные" должны быть указаны:

характер, организация и предварительная подготовка входных данных;

формат, описание и способ кодирования входных данных.

10. В разделе "Выходные данные" должны быть указаны:

характер и организация выходных данных;

формат, описание и способ кодирования выходных данных.

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

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

7-12. (Введены дополнительно, Изм. N 1).



Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной документации:
Сборник национальных стандартов. -
М.: Стандартинформ, 2010

Описание программы (ГОСТ 19.402-78 ) должно содержать:

1 Общие сведения о программе – полное наименование, обозначение, ее возможные применения, а также программное обеспечение, необходимое для функционирования программы, и языки программирования, на которых она написана. Например:

Программа "Автоматизированное рабочее место разработчика САУ" предназначена для… реализована на… Программа поддерживает…

Программа написана на языке…с использованием компилятора…

2 Функциональное назначение – назначение программы и общее описание функционирования программы, ее основные характеристики, сведения об ограничениях, накладываемых на область применения программы. Например:

Программа предназначена для решения задач… Программа представляет собой ядро автоматизированного рабочего места…

Пользователь имеет возможность…, осуществить…, запустить…, проанализировать…, получить результаты анализа и обработки…, построить… и т.п.

3 Описание логической структуры – используемые методы, алгоритмы программы, описание структуры и логики программы (c привязкой к тексту программы на исходном языке) и ее составных частей, их функций и связей между ними, а также связи программы с другими программами. Содержание этого раздела должно быть конкретным и опираться на текст программы.

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

Метод решения может быть представлен:

– в виде системы формул (безусловной или условной);

– в виде словесного изложения последовательности действий;

– в виде их комбинаций.

Описание метода может содержать ограничения на исходные данные, накладываемые методом.

Схемы алгоритмов, программ, данных и систем , приводимые в этом разделе, должны использовать метод пошаговой детализации. Причем уровень детализации должен быть таким, чтобы различные части программы и взаимосвязи между ними были понятны в целом. Другими словами сначала нужно описать обобщенную схему алгоритма, разбив программу логические блоки, а затем подробно рассмотреть схемы алгоритмов работы каждого из этих блоков. Условные обозначения и правила выполнения схем определяются ГОСТ 19.701-90 (Приложение Б) .

В состав программы входят следующие модули:

– пользовательский интерфейс;

– модуль определения путей в графе;

– модуль расчета передаточной функции;

– модуль построения амплитудно- и фазочастотных характеристик;

– модуль построения реакции на полиномиальное воздействие;

– текстовый редактор.

Интерфейсный модуль построен на двух типах диалогов: диалог "вопрос – ответ" и диалог типа "меню". Интерфейсный модуль управляет…

Модуль определения путей в графе основан на использовании метода… Он является…

Модуль расчета передаточной функции реализует метод… и т.д.

Алгоритм определения путей в графе имеет вид: …

4 Используемые технические средства – типы ЭВМ и устройств, используемых при работе программы. Например:

Программа эксплуатируется на персональном компьютере (ПК) типа IBM PC/AT. Для работы в диалоговом режиме используется экран дисплея, клавиатура и манипулятор типа "мышь". Для поддержки графического режима необходим адаптер S VGA. Входные данные хранятся на гибком и/или жестком дисках. Программа работает под управлением ОС…

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

6 Входные данные – характер, организация и предварительная подготовка входных данных, их формат, описание и способ кодирования.

Описание структуры входных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.

В этом же разделе должно приводиться перечисление аномалий во входных данных (значения, для которых нельзя применять реализуемый метод решения) и реакций программы на них.

Входными данными для программы является текстовый файл, описывающий расширенную матрицу инциденций графа исследуемой системы. Этот файл имеет следующую структуру…

Используемый метод определения… не может быть использован при…, поэтому эти значения являются недопустимыми, а программа реагирует на них выводом сообщения…

7 Выходные данные – характер и организация выходных данных, их формат, описание и способ кодирования.

Описание структуры выходных данных включает указание типов данных, диапазонов их значений, форматов представления и т.д.

Выходными данными являются:

– выводимая на экран графическая и текстовая информация (результаты анализа системы);

– файлы в одном из графических форматов – копии изображения построенных характеристик (АЧХ, ФЧХ и т.д.);

– текстовые файлы – отчеты о проведенных исследованиях в формате… ;

– диагностика состояния системы и сообщения обо всех возникших ошибках.

В зависимости от особенностей программы допускается введение дополнительных разделов.