ГОСТ 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*.
________________
* Доступ к международным и зарубежным документам, упомянутым здесь, можно получить, перейдя по ссылке на сайт http://shop.cntd.ru . - Примечание изготовителя базы данных.

(Измененная редакция, Изм. 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.101-77 определяет описание программы как совокупность сведений о логической структуре и функционировании программы. Описание программы должно состоять из четырех основных частей: титульной части, информационной части, основной части, части регистрации изменений.

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

В зависимости от особенностей программы допускается вводить новые разделы или объединять отдельные разделы. При описании программного продукта, содержащего несколько программных единиц (программ, подпрограмм), описание по указанной схеме дают для каждой программной единицы, придерживаясь при этом иерархии компоновки общего программного продукта. Так, например, если общая программа Control включает обращение к функции FileExist и процедуре Brackets, которая в свою очередь обращается к процедуре Error, и общая схема иерархии данного программного продукта изображена на рисунке 6, то описание необходимо начинать с программной единицы Control далее описывать программные единицы FileExist, Brackets, Stack, затем описать программную единицу Error в составе Brackets

Пример иерархии сложного программного продукта приведен на рисунке 6.

Программа контроля

расстановки скобок

в программах

Brackets FileExist Stack

Процедура проверки Функция проверки Модуль

правильности существования для работы

расстановки скобок файла со стеком

Error

Процедура InitStack EmptyStack InStack OutStack

Расшифровки Процедура Функция Процедура Процедура

ошибок инициализации проверки включения извлечения

стека пустоты стека элемента элемента

в стек из стека

Рисунок 6 – Структурная диаграмма программы

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

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

В разделе "Описание логической структуры" приводится структурная диаграмма программы, в которой указываются имена и назначение составляющих модулей и подпрограмм (рисунок 6). Словесное описание структурных единиц программы сопровождается представлением укрупненных схем алгоритмов, в целом, не более трех листов. На первом листе приводится укрупненная схема алгоритма функционирования главной программы. Кроме этого, представляются схемы алгоритмов тех подпрограмм, которые отображают суть метода решения задачи. Примеры схем алгоритмов приведены на рисунках 7, 8, 9, 10.

Оформление схем алгоритмов должно соответствовать требованиям ГОСТ 19.701-90 "Схемы алгоритмов, программ, данных и систем". Первым блоком в любой схеме является блок ПУСК (или НАЧАЛО):

Соединительные линии в схеме, называемые иначе линиями потока, не должны пересекаться, для этого применяются внутристраничные соединители

и межстраничные соединители

12 [ с листа...

12 [ на лист…

Стрелка, направленная к соединителю, означает, что управление передается блоку, номер которого указан внутри соединителя. Стрелка, направленная от соединителя, означает, что управление передается от блока, номер которого указан внутри соединителя. Каждая схема алгоритма для отдельной программной единицы изображается на отдельном рисунке. Рисунки нумеруются подряд внутри одного документа. Каждый рисунок имеет название, которое пишется над рисунком, и номер, который пишется под рисунком. Названием рисунка с изображением схемы алгоритма может служить наименование соответствующей программной единицы, например: "Схема алгоритма программы контроля" или "Схема алгоритма подпрограммы Error". Примеры схем алгоритмов приведены на рисунках 7, 8, 9, 10.

Рисунок 8 - Функция FileExist Рисунок 9 - Процедура Error

Рисунок 10 – Схема алгоритма процедуры Brackets

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

В разделе "Используемые технические средства" необходимо указать типы ЭВМ, конфигурацию вычислительного комплекса, для которого разработано описываемое программное средство. Если программа учитывает особенности операционной среды, то следует указать ту операционную среду, в которой работает эта программа.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Инструкция

Чтобы описать программу , начните с общего вступления. Опишите основную проблему, с которой сталкивается пользователь. Естественно, это должна быть та самая проблема, которую и решает описываемая программа. Кстати это способ сразу же очертить целевую аудиторию пользователей. Те, кому она будет полезна и необходима, ее скачают или купят. Другие же пользователи сэкономят время и не станут далее . Также во вступлении опишите основные возможности программы. Для этого достаточно 1-2 предложений.

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

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

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

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

Без сомнения можно сказать, что целевая аудитория - это ключевая фигура любого бизнеса, те, ради кого все дело, собственно и организованно. Говоря проще - это покупатели ваших товаров или услуг.

Инструкция

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

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

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

Консервативность старшего поколения подтолкнет их купить товар, которым они будут пользоваться длительное (до 5-6 лет) время. Молодежь же уже привыкла к стремительному техническому прогрессу и любит пробовать все новое. Как правило, время использование нового товара достаточно ограничено и составляет от полугода до двух лет, в зависимости от сложности и технологичности товара.

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

Далее соберите фокус-группу - 10-15 человек, которые удовлетворяют вашим параметрам, и предложите им первым тестировать новые продукты и описывать впечатления. Таким образом вы сможете вовремя исправить ошибки и минимизировать потери при выводе товара или услуги на большой рынок.

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

Инструкция

Полезный совет

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

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

Инструкция

Во-первых, содержание такой программы должно соответствовать нескольким параметрам. Она должна затрагивать вопросы достижений мировой и российской , традиции своей страны и других, а также программа должна освещать вопросы культурно-национальных особенностей регионов. Когда вы пишите образовательную , обязательно нужно учитывать возраст тех , на которых она рассчитана. Ведь для младших существуют одни стандарты, а для старших абсолютно другие. Желательно, чтобы в плане развития детей на год присутствовали пункты, посвященные дополнительным образовательным программам. Например, это могут быть социально-педагогическое направление, военно-патриотическое, социально-экономическое и другие. Также учителя должны быть современными и учитывать в своей программе современные образовательные технологии (то есть такие, которые индивидуальность детей, результативность их школьной деятельности и другие аспекты).

В содержании образовательной программы не забывайте описать, какие условия созданы для развития личности ребенка, как учащемуся можно повысить мотивацию к познанию и творчеству. Также педагоги в своем должны учитывать и описывать, как они будут обеспечивать эмоциональное благополучие ребенка, а также как именно они планируют объяснить и научить ребенка общечеловеческим ценностям. По требованию Министерства России учителя обязаны прописать в программе, как они предполагают создавать условия для того, чтобы ребенок мог самоопределиться и как личность, и как профессионал уже в .

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

Кроме рекомендаций по внутреннему наполнению образовательной программы есть еще и целый ряд требований к оформлению такого документа. Так, например, она обязательно должна иметь титульный лист, пояснительную записку, учебно-тематический план, содержание изучаемого курса, описание используемых методических материалов и книг для дополнительного образования. И, конечно же, заканчиваться этот научный учительский труд должен списком литературы.

Exe-файл в операционной системе Windows - это исполняемый файл программ. Он представляет собой специальным образом обработанный код, написанный программистом, скомпилированный и преобразованный в исполняемый тип. Поэтому взять блокнот и написать файл exe, как это можно сделать с bat- или inf-файлами, нельзя.

Вам понадобится

• - знание программирования.

Инструкция

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

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

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