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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Программа называется 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. Форма Ввод пароля

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Руководство о том, как правильно составлять описание приложения для магазина.

App Definition включает в себя 3 части: название, описание, и скриншоты. Давайте рассмотрим вопрос app definition кратко и более подробно.

Если кратко.

Название

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

Описание

По структуре:

  1. Первые 1–3 предложения в описании должны максимально четко описывать идею приложения и рассказывать, какую проблему оно решает. Максимальная длина этой части 255 символов.
  2. Если у приложения есть особые заслуги (featured on TechCrunch), о них нужно говорить.
  3. Основной текст описания может иметь 2–3 абзаца. Здесь мы расписываем характеристики и детали.
  4. В конце должен быть список главных функций с их четким описанием.
  5. В самый конец описания мы помещаем секцию “что нового?” Исправили баги, добавили фичи, поменяли звездочку на сердечко – все это здесь.
  • Описание должно понятно объяснить пользователю, как работает приложение и зачем оно нужно.
  • Ключевые слова нужно вставить в контекст всего описания, а не только названия.
  • Писать описание нужно от второго лица, с точки зрения пользователя, избегая технических деталей, и неясностей.

Скриншоты

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

А теперь подробнее.

1. Как называется ваш продукт? Зачем он нужен?

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

Предназначение продукта – это ключевое слово, по которому пользователи находят приложение в апп сторах или google. Забив в google “app development company” мы найдем Yalantis , потому что наше полное название – Yalantis is a native iOS and Android app development company.

А если мы загуглим travel app, то поиск выдаст нам TripIt (с полным названием TripIt Travel Organizer – Free), TripAdvisor (TripAdvisor Hotels Flights Restaurants), TripCase (TripCase – Travel Organizer) и прочие приложения туристической тематики.

Возьмем, к примеру My Day . Его название на апп сторах звучит так:

My Day – Countdown Timer

Именно countdown timer, countdown app в данном случае, ключевое слово, по которому наше приложение находят пользователи.

Flipboard: Your Social News Magazine

Четко и понятно зачем нам нужен Flipboard, и сразу 3 ключевика: news, social и magazine.

Один из наших недавних проектов, Vochi, назвается на App Store:

Vochi messaging – Future Delivery

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

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

  • – Gay, same sex, bi, social network to chat and meet guys
  • – Discover Music, Artists, Videos & Lyrics
  • Polyvore – Personalized Fashion, Shopping and Style
  • Magisto – Video Editor & Movie Maker

В названии приложения допустимо иметь максимум 25 символов. Если слов будет больше, в поиске их просто не будет видно.

Теперь приступим к составлению описания для апп стора.

2. Как написать описание продукта?

1. Правила

Стараясь описать приложение для апп стора как можно лучше, необходимо соблюдать следующие правила:

  • SLAP – Stop, Look, Act, Purchase. Другими словами, захвати внимание пользователя используя односложные предложения с подлежащими и глаголами с самого начала. Передавая смысл просто и ясно, ты подтолкнешь пользователя к действию.
  • KISS – Keep it simple stupid. Вырежь все лишние слова, в которых нет никакого смысла. Не используй жаргон, это может отпугнуть.
  • WIIFM – What’s in it for me? Что пользователь получит, узнает, ощутит, скачав приложение? Какой у продукта value proposition?

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

Для того, чтобы составить дельное описание, нужно четко ответить на следующий вопрос.

2. Какие функции выполняет ваше приложение?

Как правило, приложения выполняют довольно много разных функций от регистрации до terms and conditions. Однако, для описания продукта нам не нужны абсолютно все функции. Достаточно выделить несколько основных, и одну самую важную. Важная функция – это ваше value proposition, конкурентное преимущество и позиционирование вашего продукта на рынке .

Если ваше приложение позиционируется, как лучший блокнотик – сосредоточьтесь на этом функционале. Лучше говорить об одном специфическом use case, чем рассыпаться мыслями по древу обо всех фичах, которые вы вложили в продукт.

Для нашего My Day, самая важная функция – countdown clock with reminder. Другие функции, перечисленные в описании, это обои, праздники, виджет, настройки цвета и стиля, и единицы времени, которые аппа способна высчитывать. Мы позиционируем My Day как красивый и удобный продукт, и в этом его ценность.

3. Из чего состоит описание?

Повествование о приложении для апп сторов можно разделить на 5 частей:

  1. 255 символов
  2. Ревью и награды (если есть)
  3. 2–3 абзаца основного текста
  4. Спиcок функций
  5. Что нового?

4. 255 первых символов

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

Иногда проблема, которую решает приложение, очевидна. Например, для фитнес приложения – это возможность брать тренировки с собой и заниматься физкультурой где душе угодно. Для дейтинговых апп, matching на основе технологии face recognition увеличивает шансы пользователя встретить свою половину. Социалочка для механиков дает им возможность обсудить аккумулятор не выходя из гаража. Приложение для недвижимости – счастливое освобождение от несговорчивых риэлторов и траты времени впустую.

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

is the entertainment network where videos and personalities get really big, really fast.

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

Watch videos that create trends, influence culture and make you laugh. Discover stories, characters and remixes you can’t find anywhere else. Be the first to hear incredible new artists and songs.

Ну все, тут меня уже окончательно купили. Я и тренд могу создать, и посмеяться, и вообще, там есть stories you can’t find anywhere else, то есть Vine – уникальное предложение.

И заметьте, watch videos, discover stories, new artists and songs – это явно ключевики, правильно вставленные в контекст.

Однако, бывает и так, что проблема не очевидна. Например, Uber и Instacart – это продукты, созданные ради комфорта. Когда их только выпустили, пользователи и сами не знали, что у них была проблема, которую эти ребята хотели решить. Но теперь-то знают!

Еще пример:

Rewind Time Tracking app : The best time tracking solution is the one you don’t even have to think about. Rewind automatically tracks your time based on your location. You just have to set up your important places and you’re done.

Поглядим:

Tracks time based on your location – вот она суть.

The best time tracking solution is the one you don’t even have to think about. – а вот это проблема, которую решает приложение.

You just have to set up your important places and you’re done. – а вот как пользоваться трекером.

5. Ревью и награды

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

Примеры ревью:

  • Quip – Docs, Chat, Spreadsheets: ** Featured in MIT Technology Review’s 10 Breakthrough Technologies 2014 **
  • Wish – Shopping made fun: “Love, love this app. It’s a fun app that u can wish on things u love and want. Highly recommend it to frndz & fmly,” – Olivia Austin . (гугл говорит, что это порно стар)
  • “A must have for moms! ” – TechCrunch

Примеры наград:

  • AP Mobile is the award-winning app from The Associated Press, the definitive news source relied upon by thousands of newspapers, broadcasters and digital news providers worldwide .
  • Musixmatch Lyrics Finder: Musixmatch is the world’s largest lyrics catalog, that lets you enjoy diverse music with synced lyrics. Out of 155 countries it was selected for the Editor’s Choice on the App Store and was also chosen as an App Of The Year in 2013.

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

  • news source relied upon by thousands of newspapers
  • the world’s largest lyrics catalog

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

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

6. Основной текст

Описания для апп стора похожи на статьи в газетах: самая важная новость идет вперед, а менее важная и детали следуют за ней.

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

В первых 2–3 предложениях мы уже сказали все самое главное:

Wunderlist helps millions of people around the world capture their ideas, things to do and places to see. (Wunderlist: To-Do List & Tasks)

Теперь, пришло время немного углубиться в детали и характеристики. К тому же, основной текст – отличное место для ключевиков (но ни в коем случае не повторяйте то, что уже сказали в начале).

Whether you’re sharing a grocery list with a loved one, working on a project, or planning a vacation, Wunderlist makes it easy to share your lists and collaborate with everyone in your life. Wunderlist instantly syncs between your phone, tablet and computer, so you can access your lists from anywhere.

Из первых строк описания я уже поняла, зачем нужен Wunderlist, а теперь мне рассказывают, что конкретно можно заносить в списки и как ими пользоваться.

Заметьте, после перечня функций, Wunderlist подробно рассказывает пользователям за что ему дать денег:

Wunderlist is free to download and use. Wunderlist Pro upgrades your experience and gives you unlimited access to Files, Assigning and Subtasks to help you accomplish even more for $4.99 a month or $49.99 a year through an auto-renewing subscription.

7. Список функций

В списке желательно иметь от 3 до 7 функций, и все они должны иметь название и краткое описание. Иногда название фичи выносится заголовком, за которым следует предложение с текстом:

VSCO Journal: Publish original content to your Journal and share with the creative community. Find inspiration on the VSCO Journal, a publication highlighting creatives from around the globe.

Еще пример:

NYC Apartments and Real Estate by StreetEasy – приложение, которые мы разрабатывали для компании Zillow. Его основная функция – это поиск недвижимости, потому и в описании на апп сторе слово search встречается чаще всего. Помимо этого, перечисленны такие функции как:

  • ability to view, save and share for-sale and rental listings
  • email and call agents directly from the app
  • tap into the database for all kinds of market- and property-level facts and history

И еще один удачный пример из категории health & fitness:

FitStar Personal Trainer – Burn Calories & Lose Weight with Video Fitness Workouts led by Football Legend Tony Gonzalez (ну оочень длинное название). Основная функция этого приложения – видео тренировки. Но в добавок, перечислены следующие фичи (вкратце):

  • HD videos with legend
  • Challenges (setting personal goals)
  • Apple TV
  • Custom audio tracker
  • Track progress
  • Connect FitBit, Jawbone UO, MyFitnessPal
  • Integrated with Health app

Описывая функции, нужно соблюдать следующие правила:

  1. Не делай описание функций слишком длинным.
  2. Помести две наиболее важные функции в начале, а третью самую важную в конце.
  3. Здесь никто ничего не читает.
  4. Здесь никто ничего не читает.
  5. Каждая новая функция должна начинаться с нового слова, и желательно, чтобы первое слово во всем списке относилось к одной части речи (глаголы, прилагательные, существительные).
  6. Третья самая важная функция.

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

8. Что нового?

Например:

  • Now supporting iOS 9
  • Likes: See who liked your post
  • Now you can book up to 4 hotels at once on the app
  • Fixed a bug affecting some iPhone 6 and 6 Plus readers

9. Что можно и чего нельзя делать в описании?

Можно :

  • Value proposition в сжатом виде
  • Фраза “ideal for”
  • Убеждение: “Free forever!”
  • From the creators of…

Нельзя :

  • Злоупотрелять ключевыми словами в описании (слишком много ключевиков и отсутствие связи с контекстом описания негативно воспринимается пользователями)
  • Допускать грамматические ошибки и опечатки
  • Говорить техническим языком
  • Писать что-то вроде: Наш продукт был сделан в Нью-Йорке разработчиком Сидоровым.
  • Врать (в ответ получим плохие отзывы)
  • Писать запутанно и абстрактно
  • Гиперболизировать (использовать словечки типо revolutionize, revolutionary, game changing, disruptive, если это не правда на самом деле)

3. Как написать описание к скриншотам?

  • четко
  • информативно
  • коротко

Скриншоты должны описывать главные функции приложения, и говорить о конкретных use cases. Первый скриншот – самый важный, он должен описывать value proposition. Всего скриншотов должно быть 5.

ShopBob – Women’s Fashion

  • Shop the latest fashions and get trend updates and styling tips
  • Dresses to denim, shoes to swimwear, find what you’re shopping for now
  • Shop the latest styles first and create a personalized boutique of favorites
  • See all gorgeous details up close
  • The designers to put on your radar now

ShopBob – магазин, потому первый скрин говорит: купи.

Желательно начинать описание скриншота с глагола, а если функционал ограничен, то с существительного.

My Day – Countdown Timer

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


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

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

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

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