Описание программы гост 19 пример. Как написать хорошее описание к приложению? Описание логической структуры

Общие сведения.

Программа называется jane и сохранена в файле jane.dpr. Программа использует вспомогательные модули main, new, dmData, about, сохранённые соответственно в файлах main.pas, new.pas, about.pas, dmData.pas. Программа написана на языке программирования Delphi. Программа использует данные из таблиц базы данных otdel.db, sotrudnik.db, family.db, obrazovanie.db

Функциональное назначение.

Реализация графа диалога.

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

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

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

Рисунок 17. Дерево экранных форм

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

Программа управляется событийно. При нажатии на какую-либо кнопку в программу поступает сообщение, при этом вызывается соответствующая процедура-обработчик, которая обрабатывает данное событие. Результаты обработки можно видеть на экране монитора. Например: при нажатии на кнопку “Работа” в форме “Дипломный проект” вызывается процедура, содержащаяся в модуле New, которая скрывает форму “Дипломный проект”, выводит на экран монитора форму “Кадровый учет”, при этом управление передается модулю Main.

Для выполнения программы необходимо загрузить на персональном компьютере программную оболочку Delphi, откомпилировать исходный текст программы, содержащийся в файле jane.dpr. Вызвать exe файл и далее работать с ним. Перед началом работы необходимо пройти процедуру авторизации (рисунок 18).

Рисунок 18. Форма Ввод пароля

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

Входные данные:

название отдела,

ФИО начальника,

ФИО сотрудников, должность,

дата приема на работу,

место последней работы,

стаж на дату приема,

признак наличия образования,

признак наличия семьи,

количество детей,

семейное положение,

даты рождения,

тип образования,

форма обучения,

учебное заведение,

дата окончания,

специальность.

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

ГОСТ 19.101-77 определяет описание программы как совокупность сведений о логической структуре и функционировании программы. Описание программы должно состоять из четырех основных частей: титульной части, информационной части, основной части, части регистрации изменений.

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

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

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

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

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

в программах


Brackets FileExist Stack

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

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

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

Процедура 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


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

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

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

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

Текст программы

Пример.

Спецификация программы

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

1. в графе "Обозначение" указывают обозначение основных программных
компонентов;

2. в графе "Наименование" указывают полное наименование соответствующего компонента;

3. в графе "Примечание" - дополнительные сведения, относящиеся к записанным в спецификации программам.

Исполняемый файл программы "Игра "Лабиринт"" имеет название Labirint.exe и расположен на диске F в каталоге Student\Kursov\Labirint. Состав проекта:

Наименование Обозначение Примечание
Acl Файл плана помещений Создается в приложении
Helpi Файл помощи Создается в приложении
Labirint.Dof Файл параметров проекта Содержит, текущие установки проекта: настройки компилятора и компоновщика, имена служеб­ных каталогов, условные дирек­тивы
Labirint.Dpr Файл проекта Связывает все файлы, из которых состоит приложение
Labirint.Dsk Файл, содержащий Desktop-настройки проекта Содержит информацию о том, какие окна открыты и в каких позициях они расположены
Labirint.Res Файл ресурсов Содержит пиктограммы, графи­ческие изображения
Unit 1. Pas Файл программного моду­ля для формы №1 Определяет функциональность формы №1.
Unit2.Pas Файл программного моду­ля для формы №2 Определяет функциональность формы №2.
U»it3.Pas Файл программного моду­ля для формы №3 Определяет функциональность формы №3.
Unitl.Dfm Файл формы №1 Содержит список свойств всех компонентов, включенных в форму №1.
Unit2.Dfm Файл формы №2 Содержит список свойств всех компонентов, включенных в форму №2.
Unit3.Dfm Файл формы №3 Содержит список свойств всех компонентов, включенных в форму №3.
Uuitl.Dcu Объектный файл для Unit1. Pas Откомпилированная версия Unit1.Pas.
Uuit2.Dcu Объектный файл для Unit2.Pas Откомпилированная версия Unit2.Pas.
Unit3.Dcu Объектный файл для Unit3.Pas Откомпилированная версия UnM.Pas.

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

Раздел "Описание программы" согласно ГОСТ 19.402-78 должен содержать следующие подразделы:

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

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

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

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



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

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

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

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

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

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

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

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

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

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

Зачем нужно описание приложения?

Процитирую Капитана Очевидность: оно необходимо, чтобы ваши покупатели знали, что из себя представляет ваше приложение. Для чего оно. С точки зрения разработчика описание — это возможность «зацепить» покупателя. Вам нужно продать идею. Вам нужно рассказать, почему им нужно скачать именно ваше приложение, а не любое другое.

Тот, кто читает ваше описание, уже нашел ваше приложение в поиске. Название и скриншоты уже показались ему достаточно привлекательными, чтобы нажать кнопку «еще». Образно говоря, он уже вытащил кошелек, — осталось заставить его оплатить покупку.

Вступление

В вашем распоряжении ограниченное количество слов. Взгляните на описание приложений — под иконкой в App Store помещается всего пара строчек.

Самые жесткие ограничения накладывает экран iPhone — у вас в запасе всего 225 символов. Это — самая важная часть вашего описания. Целиком описание ограничивается четырьмя тысячами символов, но именно от первых двух сотен зависит, захотят ли покупатели прочитать остальные.

Нужно выражаться чётко и ясно. Название приложения — и скриншоты — уже должны были в целом рассказать покупателю о том, что оно из себя представляет. Теперь нужно усилить это впечатление.

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

Тут есть несколько простых правил.

  • Завладейте вниманием своего покупателя. Ставьте существительные и глаголы в начале предложения, чтобы сделать фразу динамичной и максимально понятной.
  • Не используйте жаргон, он может оттолкнуть. Отсеките все лишнее: вводные слова, деепричастные обороты, излишне цветистые выражения.
  • В чем ценность вашего приложения? Что покупатель получит, узнает или испытает, когда загрузит его?
  • Для того, чтобы увидеть, как будет выглядеть описание вашего приложения на экране iPhone or iPad, воспользуйтесь предварительным просмотром в бесплатной программе .
  • Итак, наживка на крючке — время закинуть удочку. Иными словами, закончили со вступлением, — продолжаем описание.

Детали

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

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

Не пренебрегайте абзацами. Люди пугаются, когда видят текстовое «полотно». Варьируйте длину предложения — это делает текст более выразительным. Используйте подзаголовки и переносы строки. Списки — тоже неплохой способ «разбить» текст и сделать его более привлекательным.

Списки

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

  • не делайте их слишком длинными;
  • два самых важных момента поместите наверх списка, остальные — внизу;
  • этот пункт вы, наверное, не прочитали;
  • этот точно не прочитаете.

Велик соблазн записать все особенности приложения списком. Можете попробовать, но учтите — люди обычно читают первые два пункта и последний. Середину они пропускают, точно так же, как и предложения, которые начинаются с одних и тех же слов.

Так что лучше будет разбить длинный список на несколько небольших, объединенных одной темой.

Поиск

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

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

Локализация

Локализовать ваше приложение — относительно недорогой и простой способ увеличить количество скачиваний. У него практически нет недостатков. Исследование, которое провела Common Sense Advisory среди 3000 покупателей из 10 неанглоговорящих стран, показывает: более 75% респондентов хотят, чтобы приложение было на их родном языке.

В отчете, который озаглавлен «Не прочитаю — не куплю», помимо этого, указано: 55% пользователей совершают покупки только на тех сайтах, где представлена информация на их родном языке. Интересно, что при этом 50% опрошенных отметили, что их устроила бы даже навигация и часть контента на родном языке. То есть даже частичный перевод даст лучшие результаты, чем его полное отсутствие.

Учитывая этот факт, переведите хотя бы описание, если не все приложение целиком.

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

Убедитесь, что компания, которая занимается переводом, обладает соответствующими навыками. Google Translate вряд ли сможет передать те оттенки смысла, которые вы вложили в текст.

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

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

Обновления

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

Описание — это не только окно в ваше приложение, но еще и возможность получить высокий поисковый рейтинг.

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

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

Если пользователи задают одни и те же вопросы, подумайте над созданием раздела FAQ на сайте приложения.

Если у вас уже есть успешный проект, не забудьте его упомянуть. Или можете оставить описание вида «если вам понравилось это, возможно, понравится еще и вот это» в конце другого своего приложения.

Распространенные ошибки и как их избежать

Опечатки и пунктуационные/грамматические ошибки. Пригласите специально обученного копирайтера или, в крайнем случае, включите в текстовом редакторе проверку орфографии.

Запутанное и косноязычное описание. Если пользователь вас не поймет — то приложение он не скачает.

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

Все тайное становится явным. Правда о вашем приложении вскроется в течение нескольких секунд после загрузки — и потом будет храниться в кеше Google вечно. Так что не врите.

Слишком много ключевых слов. Я уже упоминал, что неуклюжие попытки напихать в текст как можно больше ключевых слов только оттолкнут покупателя.

В описании не учтены интересы ЦА. Пишите не для себя и не для конкурентов, — пишите для покупателя.

Пропущены важные детали. Сколько весит приложение? Сколько стоит подписка? Это не та информация, которой стоит пренебрегать.

Итак, приступаем

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

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

Напишите черновик описания или наймите для этой цели талантливого копирайтера.

Правьте, корректируйте и переписывайте заново — для максимального эффекта. Проверьте, как описание будет выглядеть на экране iPhone или iPad. Работайте до тех пор, пока оно не станет гладким, отточенным и привлекательным.

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

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

Хорошее описание к приложению поможет его продать и стимулирует загрузки.

Постановлением Государственного комитета СССР по стандартам от 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)