Как описать программу пример. Описание структуры программы. Из чего состоит описание

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

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

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

Вступление

В вашем распоряжении ограниченное количество слов. Взгляните на описание приложений — под иконкой в 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. Работайте до тех пор, пока оно не станет гладким, отточенным и привлекательным.

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

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

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

5.6. ПРИМЕР ОПИСАНИЯ ПРОГРАММЫ "РЕДАКТОР ТЕКСТОВ"

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

Программа "Редактор текстов" предназначена для создания новых и корректировки существующих текстовых файлов MS DOS в диалоговом (пользователь-ЭВМ) режиме работы. ЭВМ формирует экран с окном, в котором отображен участок текста из текстового файла (макет экрана соответствует внутреннему редактору программы Norton Commander). Пользователю обеспечивается возможность вставки в текст в окне экрана любого символа клавиатуры за символом, отмеченным на экране курсором. Исключение составляет ряд символов, которые являются признаками команд управления или незадействованными символами (приводится список символов). После подачи пользователем команды записи все изменения текста, осуществленные пользователем, записываются в файл.

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

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

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

После осуществляется очистка буферного массива редактора строковых переменных из 5 * 23 = 115 строк длиной по 225 символов.

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

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

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

Из книги Пакеты программ. Требования к качеству и тестирование автора Автор неизвестен

Из книги Linux для пользователя автора Костромин Виктор Алексеевич

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

Из книги Введение в OpenGL автора Компьютеры Автор неизвестен -

12.5.3 CoolEdit - встроенный редактор программы Midnight Commander CoolEdit - это простая в использовании программа с привычными для большинства пользователей (особенно для тех, кто работал с Norton Commander под DOS или с FAR под WINDOWS) комбинациями управляющих клавиш. Кроме того, надо учитывать, что

Из книги Технологии программирования автора Камаев В А

Пример программы Результатом выполнения этой программы является построение тетраэдра с вращающимися вокруг него кольцами, на которые нанесена текстура. В среде MS Visual C++ программа может компилироваться без изменений, а при компиляции в Borland C++ придется закомментировать

Из книги О чём не пишут в книгах по Delphi автора Григорьев А. Б.

5.5. ПРИМЕР РАЗРАБОТКИ ОПИСАНИЯ ПРОЦЕССА "КИПЯЧЕНИЕ ВОДЫ В ЧАЙНИКЕ" Ниже показано пошаговое выполнение проектной процедуры на примере разработки описания процесса "Кипячение воды в чайнике". Дополните данное описание наглядными рисунками на листе 1 самостоятельно.Лист 2.

Из книги Программирование на языке Ruby [Идеология языка, теория и практика применения] автора Фултон Хэл

Из книги Программирование на языке Пролог для искусственного интеллекта автора Братко Иван

1.2.5. Пример программы В любом руководстве первой всегда приводят программу, печатающую строку Hello, world!, но мы рассмотрим что-нибудь более содержательное. Вот небольшая интерактивная консольная программа, позволяющая переводить температуру из шкалы Фаренгейта в шкалу

Из книги VBA для чайников автора Каммингс Стив

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

Из книги Как найти и скачать в Интернете любые файлы автора Райтман М. А.

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

Из книги Linux: Полное руководство автора Колисниченко Денис Николаевич

Текстовый редактор и редактор веб-страниц OpenOffice.org Writer Текстовый процессор OpenOffice.org Writer (далее просто Writer) - это наиболее известное приложение пакета офисных программ. Данная программа позволяет создавать и редактировать текстовые документы, вставлять изображения и

Из книги Защита от хакеров корпоративных сетей автора Автор неизвестен

21.4. Пример программы на С В п. 9.2.3 я сказал о состояниях процесса и перечислил среди них состояние «зомби». Зомби - это процесс, который уже завершился, но его родитель еще не получил сигнала о его завершении и не удалил его структуру из таблицы процессов. Такое может

Из книги Язык Си - руководство для начинающих автора Прата Стивен

22.3. Пример отладки программы Давайте напишем программу, которая обнуляет элементы массива a. Да, программа ничего полезного не делает, но на ее примере можно продемонстрировать работу с отладчиком gdb.Вот листинг программы:Листинг 22.1. Демонстрационная программа,

Из книги Программирование для Linux. Профессиональный подход автора Митчелл Марк

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

Из книги автора

ПРИМЕР ПРОСТОЙ ПРОГРАММЫ НА ЯЗЫКЕ СИ Давайте рассмотрим простую программу на языке Си. Следует сразу сказать, что такой пример нужен нам лишь для выявления некоторых основных черт любой программы, написанной на языке Си. Далее мы дадим пояснения к каждой строке, но, перед

Из книги автора

ПРИМЕР ПРОГРАММЫ На рис. 5.8 приведена программа, которая может оказаться полезной тем, кто занимается бегом, и которая иллюстрирует некоторые положения данной главы. Она выглядит довольно длинной, но все вычисления в ней выполняются шестью операторами, помещенными

Из книги автора

5.1.6. Пример программы Программа, приведенная в листинге 5.1, иллюстрирует методику совместного использования памяти.Листинг 5.1. (shm.c) Пример совместного использования памяти#include #include #include int main() { int segment_id; char* shared_memory; struct shmid_ds shmbuffer; int segment_size; const

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


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

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

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

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

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

Пример.

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

В разделе спецификация приводится точное название программы и ее состав. Форма спецификации приведена в приложении 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 должен содержать следующие подразделы:

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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