Описание программы. Как лучше делать описание к программе? Госты и стандарты

Данный документ относится к типу программно-эксплуатационной. Применяется к программе, комплексу, ПАК, программному компоненту или системе.
Целевая аудитория: лица, которые принимают решение о покупке и вводе в эксплуатацию программы. Документ содержит информацию о функциональных возможностях программы и сфере её применения.

ГОСТы и стандарты

Структуру и оформление документа определяется в .
Информационная часть (аннотации и содержания) в соответствии с .

В каких случаях необходим

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

Всю необходимую информацию они смогут получить из этого документа: описание программы и ее применение.

В описании программы и описании применения указываются:

Задачи, которые решает программа;
Затрачиваемые ресурсы для работы;
Вводная информация;
Выходные данные.

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

Структура описания программы (ГОСТ 19.402-78):

1. Общие сведения.
2. Функциональное назначение программы.
3. Описание логической структуры.
4. Технические средства, которые используются.
5. Вызов и загрузка.
6. Входные данные.
7. Выходные данные.

Структура описания применения (ГОСТ 19.502-78):

1. Назначение программы.
2. Условия применения.
3. Описательная часть задачи.
4. Входные и выходные данные.
5. приложения (таблицы, иллюстрации и т.д.).

Вы можете заказать разработку документа или полного комплекта документации на программное обеспечение.

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

Пример.

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

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

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

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

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

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Сделайте заключение, в котором еще раз подчеркните целевую аудиторию и основное назначение программы, упомянув ее выигрышные стороны.

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

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

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

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

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

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

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

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

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

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

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

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

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

Вступление

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

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

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

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

Понравилось? Лайкни нас на Facebook