Как написать описание программы

Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).

Как описать программу

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

Инструкция

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

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

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

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

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

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

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

Войти на сайт

или

Забыли пароль?
Еще не зарегистрированы?

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

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

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

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

• Grindr — Gay, same sex, bi, social network to chat and meet guys
• Shazam — 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 первых символов

255 символов появляются на странице сразу, то есть пользователю не нужно нажимать на кнопку, чтобы читать дальше. Именно этот текст больше всего влияет на решение пользователя скачать приложение. Здесь мы описываем самую важную функцию, или как говориться, value proposition.

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

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

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

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. Что нового?

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

Например:

• 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

• Beautiful countdown
• Event with a personal touch
• Many countdown styles
• Lots of wallpapers
• Use it as a widget!

My Day у нас красивый, и это главное, потому скрин, говорящий о красоте, впереди.

Посмотрим еще на примеры отличных скринов и подписи к ним:

4. Где брать ключевики?

• из головы
• из Google Trends
• из Google AdWords Keyword Planner
• и вот еще полезный список App Store Statistics

К слову, в App Store индексируется только название, а в Google Play — все. Несмотря на это, ключевики должны быть как в названии, так и в описании на обоих площадках, потому что пользователь ищет приложение не только в App Store, но и в привычном Google и других поисковиках.

5. Что еще почитать на тему App Definition?

• Apple Guidelines
• Google Guidelines
• Ideal For Statement
• Value Proposition
• Value Propositions That Work
• Useful Value Propositions Examples

А для пущего понимания, как продать приложение людям, обязательно послушайте этот подкаст:

• How Not to Pitch to a Billionaire?

И читайте Пола Грема:

• Paul Graham Essays

Если вы нашли опечатку — выделите ее и нажмите Ctrl + Enter! Для связи с нами вы можете использовать info@apptractor.ru.

• Просмотр(активная вкладка)
• Members

[current-user:field-developer-organization]

УТВЕРЖДЕН

[current-user:field-decimal-number] — ЛУ

[current-user:field-full-program-name]

13 — ОПИСАНИЕ ПРОГРАММЫ ГОСТ 19.402-78

[current-user:field-short-program-name]

[current-user:field-decimal-number] XX 01

Листов

2021

Аннотация

Настоящий документ представляет собой Описание программы ПК «Интероперабельность» — [current-user:field-short-program-name].

Документ предназначен для участников команды проекта, осуществляющих разработку ПК «Интероперабельность» — [current-user:field-short-program-name], а также персонала ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization], ответственного за эксплуатацию ПК «Интероперабельность» — [current-user:field-short-program-name] в части использования по назначению, модификации или модернизации.

Основная часть документа содержит общие сведения, сведения о функциональном назначении, описание логической структуры, сведения об используемых технических средствах, способах вызова и загрузки ПК «Интероперабельность» — [current-user:field-short-program-name], входных и выходных данных.

Вставка Содержания (оглавления): Ссылки — Оглавление

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

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

Обозначение программы — NU.УЖОС.13666-13 — [current-user:field-decimal-number].

…

Можно что-то дописать.

Полное наименование — «Программный комплекс взаимодействия с онлайновыми сервисами поиска и анализа веб-страниц» — [current-user:field-full-program-name].

Краткое наименование — ПК «Интероперабельность» — [current-user:field-short-program-name].

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

Клиентская часть ПС:

• операционная система с поддержкой программного обеспечения доступа в Интернет;
• браузер (за исключением консольных и Интернет Ехплорер версии ниже 6.0).

Серверная часть ПС:

• веб-сервер Apache (рекомендуется), Nginx, Lighttpd или Microsoft IIS;
• СУБД MySQL 5.0.15 и выше, PostgreSQL 8.3 и выше или SQLite 3.x;
• PHP версии 5.2.4 и выше;
• поддержка текстового формата PHP на веб-страницах.

Э0304 Требуемое базовое программное обеспечение определено.

ПС внешних систем (онлайновые сервисы):

• сервисы Яндекс.Поиск и поиск Google;
• сервис анализа плотности использования текста (ключевых слов контента) текущей страницы Be1.ru;
• сервис анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы веб-страниц PageSpeed Insights;
• сервисы проверки соответствия веб-страниц стандартам гипертекста CSS Validation Service и Nu Html Checker.

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

• язык гипертекстовой разметки HTML, см. HTML 4.01 Specification;
• каскадные таблицы стилей CSS — формальный язык описания внешнего вида веб-документа, разработанного с применением языка разметки HTML (XHTML), см. CSS Snapshot 2018;
• встраиваемый язык программного доступа к объектам приложений JavaScript, см. ECMAScript Language Specification;
• язык разработки веб-приложений PHP, см. Официальный сайт PHP.

2 Функциональное назначение

2.1 Классы решаемых задач

Классы решаемых задач:

• задачи поиска;
• задачи анализа (проверки и валидации);
• задачи оптимизации трудозатрат при решении задач поиска и анализа.

2.2 Назначение программы

Функциональное назначение:

• автоматическое формирование запроса (ссылки), содержащего заголовок (title) текущей страницы в качестве фактического параметра;
• автоматизированная отправка запроса в онлайновые сервисы поиска;
• автоматическое формирование запроса (ссылки), содержащего адрес (URL) текущей страницы в качестве фактического параметра;
• автоматизированная отправка запроса в онлайновые сервисы анализа.

Эксплуатационное назначение:

• производственная среда (офис) ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization];
• отдел маркетинга;
• отдел разработки и поисковой оптимизации веб-контента;
• отдел веб-дизайна и программирования.

• поддержка формата текста PHP ПС серверной части;
• поддержка REST API онлайновыми сервисами поиска и анализа (проверки и валидации).

Э0109 Наличие соответствующих границ функциональных областей — ограничения определены.

Ограничения, накладываемые на область применения ПК «Интероперабельность» — [current-user:field-short-program-name]:

• несоответствие условиям эксплуатации технических средств клиентской части;

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

3.1 Алгоритм программы

Алгоритм выполнения процедуры загрузки и вызова программы (преобразования загрузочного модуля в гипертекст программными средствами CMS Drupal):

• автоматическое формирование параметра запроса;
• автоматическое формирование строки запроса;
• автоматизированная отправка запроса во внешнюю систему (в сервис поиска или анализа).

Э0104 Функции ввода/вывода (ручной ввод данных) исключены.

3.2 Используемые методы

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

Формирование строки запроса конкатенацией текстовой строки шаблона (запроса) и текстовой строки параметра (запроса).

3.3 Структура программы

• запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization] в результатах поиска Яндекс.Поиск и Google;
• запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
• запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
• запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).

3.4 Описание функций составных частей программы

Обеспечиваются:

• автоматический старт и завершение выполнение функций в ходе процедур загрузки и вызова программы — при генерации страницы (преобразования загрузочного модуля в гипертекст программными средствами CMS Drupal);
• переход в режим ожидания использования по назначению по факту полного завершения загрузки страницы браузером пользователя.

Э0104 Функции ввода/вывода (ручной ввод данных) исключены.

Автоматическая загрузка мнемознака (пиктограммы) для формирования графической гиперссылки запроса

Тег или атрибут	Значение
alt	альтернативный текст — пустое
src	путь к изображению
style	граница 2px справа

Автоматическое формирование параметра запроса — текстовой строки заголовка (title) текущей страницы

Функция Drupal menu_get_object() возвращает тип текущего объекта. Если текущий объект является $node, то стандартная конструкция языка PHP print возвращает текстовую строку, содержащую заголовок текущего объекта (содержимое тега title страницы), например Серверная комната (аппаратная) по ГОСТ Р 58242-2018.

Автоматическое формирование параметра запроса — текстовой строки адреса (URL) текущей страницы

Функция Drupal drupal_get_path_alias() возвращает путь (алиас) текущего объекта (страницы). Стандартная конструкция языка PHP print возвращает текстовую строку, содержащую путь текущей страницы (URL), например https://tdocs.su/43471.

Автоматическое формирование строки запроса сервисам поиска

Конкатенация шаблона запроса сервиса поиска и текстовой строки заголовка (title) текущей страницы. Пример строки запроса сервису поиска изображен на рисунке .

https://yandex.ru/search/?text=Серверная комната (аппаратная) по ГОСТ Р 58242-2018

Автоматическое формирование строки запроса сервисам анализа

Конкатенация шаблона запроса сервиса анализа и текстовой строки адреса (URL) текущей страницы. Пример строки запроса сервису Be1.ru изображен на рисунке .

https://be1.ru/vfacen/?url=https://tdocs.su/43471.

Автоматическое формирование параметров окна отображения входной информации сервисов

Тег или атрибут	Значение
_blank	отображение входной информации в новом всплывающем окне
toolbar=yes	разрешено отображение панели инструментов
status=no	запрещено отображение информации о состоянии
resizable=yes	возможно изменение размеров окна
scrollbars=yes	возможно появление вертикальной полосы прокрутки
width, height	ширина и высота окна
top, left	отступ верхнего и левого края окна от поверхности визуализации

Автоматическое формирование параметров ссылки запроса

Метод javascript window.open(strUrl, winName [, winParams]) открывает новое окно браузера со сформированными параметрами. strUrl формируется методом конкатенации:

• для сервисов поиска — шаблона поискового запроса и текстовой строки адреса (URL) текущей страницы;
• для сервисов анализа — шаблона анализа и текстовой строки адреса (URL) текущей страницы.

3.5 Описание связей между составными частями программы

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

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

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

• в результате модификации ПК «Интероперабельность» — [current-user:field-short-program-name] имеется возможность расширения номенклатуры внешних систем (добавления онлайновых сервисов);
• ограничение — необходимость поддержки сервисами запросов в виде гиперссылок с параметрами заголовка (title) или адреса (URL) веб-страницы (REST API).

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

4.1 Типы электронных вычислительных машин и устройств, которые используются при работе программы

Э0303 Требуемые периферийные устройства определены.

Э0302 Требуемый объем внешней памяти определен.

Э0301 Требуемый объем внутренней памяти определен.

Рекомендованные технические характеристики ТС клиентской части:

• процессор Intel Core i7 — 9700K Socket 1151 v2 8-ядерный;
• кулер DeepCool GAMMA ARCHER BIGPRO;
• материнская плата Gigabyte Z390 AORUS PRO Socket 1151 v2;
• оперативная память 64 Gb DDR4 2400 MHz Crucial Ballistix Sport LT White (4×16 Gb KIT);
• видеокарта nVidia GeForce GTX1050 Ti ASUS PCI-E 4096 Mb (PH-GTX1050TI-4G);
• твердотельный накопитель 240 Gb SSD Western Digital 2.5″;
• блок питания 500 W Aerocool VX-500 PLUS;
• Wi-Fi адаптер ASUS PCE-N10 Wi-Fi адаптер.

Условия эксплуатации — соответствующие условиям эксплуатации IBM-совместимых ПЭВМ класса не ниже Реntium IV.

По стойкости к воздействию внешних климатических факторов в процессе эксплуатации IBM-совместимые ПЭВМ относят к средствам вычислительной техники (СВТ) 1-3-й групп [п. 1.3.1 ГОСТ 21552-84].

Нормальными климатическими условиями эксплуатации СВТ 1-3-й групп являются: температура окружающего воздуха (20 ± 5) °С, относительная влажность (60 ± 15) %, атмосферное давление от 84 до 107 кПа (от 630 до 800 мм рт. ст.) [п. 1.3.2 ГОСТ 21552-84].

5 Вызов и загрузка

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

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

Процедуры загрузки и вызова ПК «Интероперабельность» — [current-user:field-short-program-name] — автоматическое преобразование загрузочного модуля в гипертекст текущей страницы в ходе ее формирования программными средствами серверной части (CMS Drupal).

Э0104 Функции ввода/вывода (ручной ввод данных) исключены.

Гипертекст сформированной и открытой браузером страницы содержит запросы в виде гиперссылок с параметрами — заголовком (title) и адресом (URL) страницы. Запросы готовы к отправке ВСЕМ ЗАЯВЛЕННЫМ сервисам поиска и анализа путем перехода по данным гиперссылкам.

Какие-либо действия оператора в ходе загрузки, вызова и запуска ПК «Интероперабельность» — [current-user:field-short-program-name] не предусмотрены.

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

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

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

• запрос и получение позиции ссылки на текущую страницу сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization] в результатах поиска Яндекс.Поиск и Google;
• запрос и получение сведений о плотности использования текста (ключевых слов контента) текущей страницы (сервис Be1.ru);
• запрос и получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы (сервис PageSpeed Insights);
• запрос и получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (сервисы CSS Validation Service и Nu Html Checker).

6.1 Характер входных данных

Характер входных данных:

• статичный и условно постоянный, неизменный в течение длительного периода времени (для введенных данных в трактовке ГОСТ Р 52292);
• изменяемый от запроса к запросу (для поступающих данных в трактовке ГОСТ Р 56602).

6.2 Организация входных данных

Логически введенные входные данные организованы в виде шаблонов запросов.

Шаблон запрос сервиса Яндекс.Поиск

Шаблон запрос сервиса Google

Шаблон запрос сервиса Be1.ru

Шаблон запроса сервиса PageSpeed Insights

Шаблон запроса сервиса CSS Validation Service

Шаблон запроса сервиса Nu Html Checker

6.3 Предварительная подготовка входных данных

Предварительная подготовка входных данных:

• не предусмотрена.

6.4 Формат входных данных

Формат входных данных:

• гиперссылка (для введенных данных);
• веб-страница (для поступающих данных).

6.5 Описание входных данных

Описание входных данных:

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

Шаблон (запроса):

• протокол и доменное имя сервиса, например https://yandex.ru;
• формальный параметр, например search/?text=.

Знак вопроса ? указывает на начало запроса, знак равенства = отделяет формальный параметр от фактического (строки запроса).

Веб-страницы с ответами сервисов:

• на запросы поиска;
• на запросы анализа.

Структурные единицы входной информации:

• позиция ссылки на текущую страницу в результатах поиска (от сервисов Яндекс.Поиск и Google);
• академическая и классическая «тошнота» и «свет» от сервиса оценки плотности использования текста (ключевых слов контента) текущей страницы Be1.ru;
• данные о фактической скорости загрузки для компьютеров и мобильных устройств, рекомендации по оптимизации увеличения фактической скорости загрузки страницы для компьютеров и мобильных устройств от сервиса анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы PageSpeed Insights;
• сообщения об ошибках и предупреждениях (или их отсутствии) от сервиса проверки соответствия веб-страниц стандартам гипертекста Nu Html Checker;
• сообщения об ошибках и предупреждениях (или их отсутствии) от сервиса проверки соответствия веб-страниц стандартам гипертекста CSS Validation Service.

6.6 Способ кодирования входных данных

Способ кодирования входных данных:

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

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

Выходные данные — Данные, которые система или какая-то ее часть передают из этой системы или части [из п. А.15 ГОСТ Р 56602-2015].

7.1 Характер выходных данных

Характер выходных данных:

• переменный. При смене текущей страницы сайта ФГУП «СпецТяжМонтажПромСтройСельхозЦифровизация» — [current-user:field-customer-organization] изменяется адрес (URL) или заголовок (тег title) страницы.

7.2 Организация выходных данных

Шаблон (запроса):

• протокол и доменное имя сервиса, например https://yandex.ru;
• формальный параметр, например search/?text=.

Знак вопроса ? указывает на начало запроса, знак равенства = отделяет формальный параметр от фактического (строки запроса).

Фактические параметры (запроса):

• текстовая строка заголовка (title) текущей страницы (для сервисов поиска);
• текстовая строка адреса (URL) текущей страницы (для сервисов анализа).

7.3 Формат выходных данных

Формат выходных данных:

• гиперссылка, содержащая фактический параметр (гипертекст).

7.4 Описание выходных данных

Описание выходных данных:

• текстовая строка заголовка (title) текущей страницы;
• текстовая строка адреса (URL) текущей страницы.

Определение структуры выходных данных:

• Запрос на Получение позиции ссылки на текущую страницу в результатах поиска информационно-поисковых систем (поисковых машин, сервисов) Яндекс.Поиск и Google требуется для выяснения причин снижения посещаемости страницы конечными пользователями.

• Запрос на Получение сведений о плотности использования текста (ключевых слов контента) текущей страницы с применением сервиса Be1.ru необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения присущего или присвоенного странице качества.

• Запрос на Получение результатов анализа фактической скорости загрузки и основных Интернет-показателей текущей страницы с применением сервиса PageSpeed Insights необходимо для для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения потребительских свойств страницы.

• Запрос на Получение результатов проверки соответствия текущей страницы стандартам CSS3 + SVG и HTML (XHTML, SMIL, MathMLL и т.д.) с применением сервисов CSS Validation Service и Nu Html Checker (Markup Validation Service) необходимо для выяснения возможных причин снижения позиции ссылки на страницу в результатах поиска из-за ухудшения конструктивных характеристик страницы.

7.5 Способ кодирования выходных данных

Способ кодирования выходных данных:

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

8 Приложения

Шаблоны запросов сервисов поиска

Шаблоны запросов сервисов анализа

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

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

Copyright © «Техническая документация» 2004 — 2021. Заимствуйте наши материалы с блеском!

     Этот
стандарт ориентирован на документирование
результирующего продукта разработки.

     Строго
говоря, существуют два разных документа,
имеющих, правда, много общего. Это ОБЩЕЕ
ОПИСАНИЕ (ГОСТ 19.502-78) и ОПИСАНИЕ ПРОГРАММЫ
(ГОСТ 19.402-78). Однако, в силу того, что
реально создать качественно и тот, и
другой, не прибегая к почти полному
дублированию, выдирая куски, весьма
сложно, было бы достаточно реализовать
один, более общий, «гибридный»
документ. Назовем его «Описанием
программы».

     На
самом деле «Описание программы» в
своей содержательной части может
дополняться разделами и пунктами,
взятыми и из стандартов для других
описательных документов и руководств: ГОСТ
19.404-79 ЕСПД. Пояснительная записка, ГОСТ
19.503-79 ЕСПД. Руководство системного
программиста, ГОСТ 19.504-79 ЕСПД. Руководство
программиста, ГОСТ 19.505-79 ЕСПД. Руководство
оператора и
т.п. В частности, из Пояснительной записки
можно взять схему алгоритма, общее
описание алгоритма и (или) функционирования
программы, а также обоснование принятых
технических и технико-экономических
решений.

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

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

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

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

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

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

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

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

     В
разделе «Описание
логики»
указывают:
  описание
структуры программы и ее основных частей
(например: В состав программы входит
следующее:
     пользовательский
интерфейс,
     модуль
определения путей в графе,
     модуль
расчета передаточной функции,
     модуль
построения амплитудно- и фазочастотных
характеристик,
     модуль
построения реакции на полиномиальное
воздействие,
     текстовый
редактор)
  описание
функций составных частей и связей между
ними;
     Например:
Программа состоит из шести модулей:
интерфейсный модуль; модуль определения
…; модуль расчета …; модуль …и
т.п..
     Интерфейсный
модуль построен на двух типах диалогов:
диалог «вопрос — ответ» и диалог
типа «меню». Интерфейсный модуль
управляет …
     Модуль
определения … Он является …
     Модуль
расчета …и т.д.
  сведения
о языке программирования;
     Например:
Программа написана на языке …с
использованием компилятора …
  описание
входных и выходных данных для каждой
из составных частей;

Например:
ВХОДНЫЕ ДАННЫЕ. Входными данными для
программы является текстовый файл,
описывающий расширенную матрицу
инциденций графа исследуемой системы.

ВЫХОДНЫЕ ДАННЫЕ.
Выходными данными являются:

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

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

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

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

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

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

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

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

В
приложение к описанию могут быть включены
справочные материалы (иллюстрации,
таблицы, графики, примеры и т.п.)

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

Вызова и загрузки
системы

Например:
Загрузка программы осуществляется
набором в командной строке DOS имени
загрузочного модуля – SBM80N.EXE с возможным
указанием имени файла данных.

Соседние файлы в предмете [НЕСОРТИРОВАННОЕ]

• #
• #
• #
• #
• #
• #
• #
• #
• #
• #
• #