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

Программы для ЭВМ оформляются в соответствии с требованиями Единой системы программной документации (ЕСПД) . ЕСПД - набор ГОСТов, устанавливающих правила оформления, содержание, структуру программных документов.
Данный how-to содержит выдержки из ЕСПД. Полные сведения можно получить непосредственно из ГОСТов.

Краткий алгоритм оформления программы

Кратко алгоритм оформления программы и виды программных документов изображены на рисунке. Более подробно процесс оформления описан далее.

Оформление программного документа

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

Каждый отдельный программный документ оформляется по (общим для всех докуметнов ЕСПД) требованиям ГОСТ 19.101-77 , ГОСТ 19.103-77 , ГОСТ 19.104-78 , ГОСТ 19.105-78 , ГОСТ 19.106-78 , ГОСТ 19.604-78 (более подробное описание данных ГОСТов следует ниже) и ГОСТа для конкретного программного документа.

Общие требования к программным документам. ГОСТ 19.105 - 78

Требования к программным документам, выполненным печатным способом. ГОСТ 19.106 - 78

ГОСТ 19.106-78 устанавливает правила выполнения программных документов для печатного способа выполнения.

Важно отметить, что данный ГОСТ не распространяется на программный документ "Текст программы".

Материалы программного документа должны располагаться в следующей последовательности :

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

В аннотации указывают издание программы, кратко излагают назначение и содержание документа. Если документ состоит из нескольких частей, в аннотации указывают общее количество частей. Содержание документа размещают на отдельной (пронумерованной) странице (страницах) после аннотации, снабжают заголовком «СОДЕРЖАНИЕ», не нумеруют как раздел и включают в общее количество страниц документа.

Форматирование текста:

• Программный документ выполняют на одной стороне листа, через два интервала; допускается через один или полтора интервала.
• Аннотацию размещают на отдельной (пронумерованной) странице с заголовком «АННОТАЦИЯ» и не нумеруют как раздел.
• Заголовки разделов пишут прописными буквами и размещают симметрично относительно правой и левой границ текста.
• Заголовки подразделов записывают с абзаца строчными буквами (кроме первой прописной).
• Переносы слов в заголовках не допускаются. Точку в конце заголовка не ставят.
• Расстояние между заголовком и последующим текстом, а также между заголовками раздела и подраздела должно быть равно:
  • при выполнении документа машинописным способом - двум интервалам.
• Для разделов и подразделов, текст которых записывают на одной странице с текстом предыдущего раздела, расстояние между последней строкой текста и последующим заголовком должно быть равно:
  • при выполнении документа машинописным способом - трём машинописным интервалам.
• Разделы, подразделы, пункты и подпункты следует нумеровать арабскими цифрами с точкой.
• В пределах раздела должна быть сквозная нумерация по всем подразделам, пунктам и подпунктам, входящим в данный раздел.
• Нумерация подразделов включает номер раздела и порядковый номер подраздела, входящего в данный раздел, разделённые точкой (2.1; 3.1 и т. д.).
• При наличии разделов и подразделов к номеру подраздела после точки добавляют порядковый номер пункта и подпункта (3.1.1, 3.1.1.1 и т.д.).
• Текст документа должен быть кратким, четким, исключающим возможность неверного толкования.
• Термины и определения должны быть едиными и соответствовать установленным стандартам, а при их отсутствии - общепринятым в научно-технической литературе, и приводиться в перечне терминов.
• Необходимые пояснения к тексту документа могут оформляться сносками.
• Сноска обозначается цифрой со скобкой, вынесенными на уровень линии верхнего обреза шрифта, например: «печатающее устройство2)...» или «бумага5)».
• Если сноска относится к отдельному слову, знак сноски помещается непосредственно у этого слова, если же к предложению целом, то в конце предложения. Текст сноски располагают в конце страницы и отделяют от основного текста линией длиной 3 см, проведённой в левой части страницы.
• Иллюстрации, если их в данном документе более одной, нумеруют арабскими цифрами в пределах всего документа.
• Формулы в документе, если их более одной, нумеруются арабскими цифрами, номер ставят с правой стороны страницы, в скобках на уровне формулы.
• Значение символов и числовых коэффициентов, входящих в формулу, должны быть приведены непосредственно под формулой. Значение каждого символа печатают с новой строки в той последовательности, в какой они приведены в формуле. Первая строка расшифровки должна начинаться со слова «где», без двоеточия после него.
• В программных документах допускаются ссылки на стандарты (кроме стандартов предприятий), технические условия и другие документы (например, документы органов Государственного надзора, правила и нормы Госстроя СССР). При ссылках на стандарты и технические условия указывают их обозначение.
• Ссылаться следует на документ в целом или на его разделы (с указанием обозначения и наименования документа, номера и наименования раздела или приложения). При повторных ссылках на раздел или приложение указывают только номер.
• В примечаниях к тексту и таблицам указывают только справочные и пояснительные данные.
• Одно примечание не нумеруется. После слова «Примечание» ставят точку.
• Несколько примечаний следует нумеровать по порядку арабскими цифрами с точкой. После слова «Примечание» ставят двоеточие.
• Сокращения слов в тексте и надписях под иллюстрациями не допускаются.
• Иллюстрированный материал, таблицы или текст вспомогательного характера допускается оформлять в виде приложений.
• Каждое приложение должно начинаться с новой страницы с указанием в правом верхнем углу слова «ПРИЛОЖЕНИЕ» и иметь тематический заголовок, который записывают симметрично тексту прописными буквами.

В ГОСТе присутствует образец листа, где указаны поля, места для нумерации страниц и шифра.

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

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

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

Вступление

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

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

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

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

ГОСТ 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*.
________________
* Доступ к международным и зарубежным документам, упомянутым в тексте, можно получить, обратившись в Службу поддержки пользователей . - Примечание изготовителя базы данных.

(Измененная редакция, Изм. N 1).

2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78 .

Составление информационной части (аннотации и содержания) является обязательным.

3. Описание программы должно содержать следующие разделы:

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

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

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

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

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

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

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

4. В разделе "Общие сведения" должны быть указаны:

обозначение и наименование программы;

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

языки программирования, на которых написана программа.

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

6. В разделе "Описание логической структуры" должны быть указаны:

алгоритм программы;

используемые методы;

структура программы с описанием функций составных частей и связи между ними;

связи программы с другими программами.

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

3-6. (Измененная редакция, Изм. N 1).

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

способ вызова программы с соответствующего носителя данных;

входные точки в программу.

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

9. В разделе "Входные данные" должны быть указаны:

характер, организация и предварительная подготовка входных данных;

формат, описание и способ кодирования входных данных.

10. В разделе "Выходные данные" должны быть указаны:

характер и организация выходных данных;

формат, описание и способ кодирования выходных данных.

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

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

7-12. (Введены дополнительно, Изм. N 1).



Электронный текст документа
подготовлен АО "Кодекс" и сверен по:
официальное издание
Единая система программной документации:
Сборник национальных стандартов. -
М.: Стандартинформ, 2010

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

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

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

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

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

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

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

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

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

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