Как создать идеальное описание приложения для App Store и Google Play. Как написать хорошее описание к приложению

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

Автоматизация библиотечных процессов

Документация базы данных "Список владельцев гаражного кооператива"

База данных «Список владельцев гаражного кооператива» состоит из трех форм. Основная таблица создана с помощью Access. на первой форме расположены элементы: Data (для связи с таблицами Access с помощью свойств DatabaseName и DataSource)...

Информационно-справочная система "Контроль работы промоутеров"

Каталог электротоваров

Программа состоит из трех форм. На первой форме установлен Пароль для данной программы. Форма имеет фиксированный размер. На ней находится текстовое поле (TextBox), в которое пользователь вводит пароль, также кнопка (CommandButton)...

Написание компьютерной игры "Сбей самолет"

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

Обработка статистических данных по файлу

Программа состоит из следующих процедур: -процедура - обработчик события однократного щелчка мышью по компоненту FileListBox1: void __fastcall TForm1::FileListBox1Click(TObject *Sender); -процедура - обработчик события при закрытии формы: void __fastcall TForm1::FormClose(TObject *Sender...

Программа "Кинематическое движение"

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

Разработка представлений для отображения результатов выборки

В ходе проектирования данного программного продукта была проведена объектно-ориентированная декомпозиция, которая представлена в таблице 10.1. Таблица 10...

Разработка программы для оптимизации функции одной переменной методом дихотомии

Алгоритм: Положим, что xn = . Длина отрезка L = (|B| - |A|). Вычислим f(xn). x1 = A + ,x2 = B - . Вычисляем f(x1) и f(x2). Если f(x1) < f(xn), то исключаем интервал , для этого B = xn, xn = x1. Переход к шагу 5. Иначе к шагу 4. Если f(x2) < f(xn), то исключаем интервал для этого A = xn...

В первом диалоговом окне, при нажатии на кнопку "Старт" вызывается обработчик события BN_CLICKED, который в свою очередь создает объект класса CMDlg, являющегося наследником класса CDialog. После этого, используя метод DoModal() вызывается окно второго диалога...

Разработка программы для расчета площади треугольника по двум сторонам и углу между ними

Имя класса Список членов Спецификация доступа Назначение Cdialog DoModal() public Данная функция вызывается для отображения модального диалогового окна. SetDlgItemText(int nID, Cstring str) public Функция передает текст элементу диалога...

Реализация программного обеспечения для изображения вращения пирамиды на примере центральной проекции

При запуске программы появляется главное окно программы (рисунок 2.1), которое содержит меню, область просмотра, и управляющие элементы: "Координаты вектора вращения", "Угол вращения", "Тип движения" и кнопки действий...

Создание базы данных строительной компании

В состав данной программы входят следующие модули: 1. Главный модуль. 1) открытие других модулей (unit1, unit2, unit5, unit6, unit7, unit8, unit9, unit10, unit11...

Техническое задание на создание автоматизированных систем

Основная программа работает в трех режимах. Схема основной программы представлена на рисунке 1. Рисунок 1 - Схема основной программы В 1 режиме выводится индекс элемента,для которого сумма элементов, стоящих до него...

Электронный учебник по распределительной станции Festo

В состав программы входят: · Функция просмотра текстовых файлов; · Функция просмотра изображений; · Функция прохождения теста. Программа написана на языке программирования Borland Delphi 7 с использованием компилятора Borland Delphi 7...

ГОСТ 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


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

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

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

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