Пользовательская документация проекта Taxi My Price (TMP)

Термины и определения используемые в документации

Важно!! Если при описании какого либо элемента вы используете термины которые могут быть не понятны другим пользователям, или могут быть поняты иначе(имеют несколько смыслов) ОБЯЗАТЕЛЬНО вносите эты термины в данный словарик использую существующее разбиение на группы или создавайте новые группы для более удобного разделения и поиска в словаре.

Так же для поиска терминов можно использовать организованный поиск слов по документации.

Общие термины

Виды документации

Существует четыре основных типа документации на ПО:

  1. архитектурная/проектная — обзор программного обеспечения, включающий описание рабочей среды и принципов, которые должны быть использованы при создании ПО
  2. техническая — документация на код, алгоритмы, интерфейсы, API
  3. пользовательская — руководства для конечных пользователей, администраторов системы и другого персонала
  4. маркетинговая - описывает все что касается коммерции и PR

Архитектурная/проектная документация обычно описывает продукт в общих чертах. Не описывая того, как что-либо будет использоваться, она скорее отвечает на вопрос «почему именно так?» Например, в проектном документе программист может описать обоснование того, почему структуры данных организованы именно таким образом. Описываются причины, почему какой-либо класс сконструирован определённым образом, выделяются паттерны, в некоторых случаях даже даются идеи как можно будет выполнить улучшения в дальнейшем. Ничего из этого не входит в техническую или пользовательскую документацию, но всё это действительно важно для проекта.

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

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

Часто при составлении технической документации используются автоматизированные средства — генераторы документации. Они получают информацию из специальным образом оформленных комментариев в исходном коде, и создают справочные руководства в каком-либо формате, например, в виде текста или HTML. Использование генераторов документации и документируемых комментариев многими программистами признаётся удобным средством, по различным причинам. В частности, при таком подходе документация является частью исходного кода, и одни и те же инструменты могут использоваться для сборки программы и одновременной сборки документации к ней. Это также упрощает поддержку документации в актуальном состоянии.

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

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

Обычно, пользовательская документация представляет из себя руководство пользователя, которое описывает каждую функцию программы, а также шаги, которые нужно выполнить для использования этой функции. Хорошая пользовательская документация идёт ещё дальше и предоставляет инструкции о том что делать в случае возникновения проблем. Очень важно, чтобы документация не вводила в заблуждение и была актуальной. Руководство должно иметь чёткую структуру; очень полезно, если имеется сквозной предметный указатель. Логическая связность и простота также имеют большое значение.

Существует три подхода к организации пользовательской документации:

  1. Вводное руководство (англ. tutorial), наиболее полезное для новых пользователей, последовательно проводит по ряду шагов, служащих для выполнения каких-либо типичных задач.
  2. Тематический подход, при котором каждая глава руководства посвящена какой-то отдельной теме, больше подходит для совершенствующихся пользователей.
  3. В последнем, третьем подходе, команды или задачи организованы в виде алфавитного справочника — часто это хорошо воспринимается продвинутыми пользователями, хорошо знающими, что они ищут. Жалобы пользователей обычно относятся к тому, что документация охватывает только один из этих подходов, и поэтому хорошо подходит лишь для одного класса пользователей.

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

Технические термины

ПО - программное обеспечение, программа в нашем случае это сайт taximyprice.com

API (программный интерфейс приложения, интерфейс прикладного программирования) (англ. application programming interface, API [эй-пи-ай][1]) — набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) или операционной системой для использования во внешних программных продуктах. Используется программистами при написании всевозможных приложений.

URL - Единый указатель ресурса (англ. Uniform Resource Locator, URL /ˌjuː ɑːr ˈel/) — единообразный локатор (определитель местонахождения) ресурса.

Структура URL (общая информация) <схема>:[//[<логин>:<пароль>@]<хост>[:<порт>]][/]<URL‐путь>[?<параметры>][#<якорь>]

В этой записи:
"схема" схема обращения к ресурсу; в большинстве случаев имеется в виду сетевой протокол http или https.
"логин" имя пользователя, используемое для доступа к ресурсу
"пароль" пароль указанного пользователя
"хост" полностью прописанное доменное имя хоста в системе DNS или IP-адрес хоста в форме четырёх групп десятичных чисел, разделённых точками; числа — целые в интервале от 0 до 255.
"порт" порт хоста для подключения
"URL-путь" уточняющая информация о месте нахождения ресурса; зависит от протокола.
"параметры" строка запроса с передаваемыми на сервер (методом GET) параметрами. Начинается с символа ?, разделитель параметров — знак &. Пример: ?параметр_1=значение_1&параметр_2=значение_2&параметр3=значение_3
"якорь" идентификатор «якоря» (англ.)русск. с предшествующим символом #. Якорем может быть указан заголовок внутри документа или атрибут id (англ.)русск. элемента. По такой ссылке браузер откроет страницу и переместит окно к указанному элементу. Например, ссылка на этот раздел "Техчнические термины": http://wiki.taximyprice.com/tesaurus/index.html#tech

GET запрос - это название запроса который отправляется на сервер скрипту с помощью браузера открыто, через URL, адресную строку.

Git - Система управления версиями (от англ. Version Control System, VCS или Revision Control System) - программное обеспечение для облегчения работы с изменяющейся информацией. Система управления версиями позволяет хранить несколько версий одного и того же документа, при необходимости возвращаться к более ранним версиям, определять, кто и когда сделал то или иное изменение, и многое другое. Не следует путать с GitHub, GitLab, Bitbucket и др. — веб-сайтами для размещения git-репозиториев и совместной разработки проектов.

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

SEO термины

SEO (аббревиатура от Search Engine Optimization) — комплекс мероприятий по увеличению видимости сайта в поисковых системах по целевым поисковым запросам.

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

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

Назначение и цели создания сайта

Цель создания сайта TaxiMyPrice.com

Предоставлять самый выгодный и простой глобальный сервис для такси и пассажиров

Назначение сайта

Проект TaxiMyPrice является посредником между:

  1. пользователем сайта нуждающимся в транспортных услугах в чужой стране. (Пассажир)
  2. местным частным или юридическим лицом, которое оказывает транспортные услуги. (Частный водитель, Такси компания)
  3. юридическим лицом имеющим договорные отношения с частными и юридическими лицами оказывающими транспортные услуги. (Агрегаторы)

Проект TaxiMyPrice за отдельную плату оказывает различные удобства пользователям сайта в виде системных услуг и услуг продаваемых через ТМП магазин.

Задачи сайта

А. Начало обслуживание клиентов на территории России в городах: Москва и Санкт-Петербург.

Б. за 2018 год обслужить 1000+ сделок между пассажиром и частным водителем.

(Данные 1000 сделок будут являться тестовыми, после выполнения, которых проект начинает работу в России.)

В. В 2018 год принять участие в обслуживании приезжающих иностранцев на чемпионат мира по футболу 2018 Россия.

Порядок и правила заполнения документации

Общее правила работы с документацией (FAQ)

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

Работу с документами можно вести как на сервисе Gitlab так и локално(у себя на компьютере) в любом удобном текстовом редакторе.

В пользовательской документации мы описываем:

  1. Цели, задачи проекта;
  2. Задачи отдельных страниц сайта;
  3. Внешний вид страниц, блоков сайта и их поведение в браузере;
  4. Поведение сайта при взаимодействии с пользователем.

Для чего вести документацию?

Составление понятной и простой документации, а так же поддержание её в актуальном состоянии дает нашей команде:

  1. Единое понимание целей и задач проека;
  2. Единое представление о том как должен работать сайт и что на нем должно происходить;
  3. Облегчает планирование работ по всему проекту;
  4. Облегчает и ускоряет разработку сайта и его модулей.

Как можно работать с документацией?

Для ведения документации был выбран достаточной простой синтаксис Markdown, изучение синтаксиса которого обязательно для её ведения. Краткое описание его возможностей доступных на нашем проекте можн посмотреть в разделе "Описание синтаксиса".

Как работать с сервисом Gitlab описано в разделе "Работа с сервисом Gitlab".

Как работать с документацией у себя на копьютере подробно опишу, если в этом будет потребность у наших партнеров.

Кто и когда заполняет данную документацию?

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

Работа с сервисом Gitlab

Для обеспечения хранения и онлайн редактирования документации используется сервис Gitlab.

Gitlab - интернет сервис для хранения файлов работающих под какой либо системой контроля версий(от англ. Version Control System, VCS или Revision Control System). В нашем случае используется Git.

Удобства сервиса Gitlab

  1. Удаленное хранение документации в конфиденциальном виде;
  2. Онлайн доступ для пользователей;
  3. Удобство онлаин наполнения с возможностью предпросмотра результата;
  4. Автоотправка изменений к на сервер для сборки в более удобном для чтения виде для наших партнеров;

Удобства систмы Git

  1. Возможность одновременной работы нескольких пользователей над документацией без потери изменений;
  2. Возможность иметь несколько разных версий документации в одной файловой стстеме (ветвление в Git);
  3. Хранение истории всех изменений в документации;
  4. Возможность восстановить лбоей состояние документации из истории.

Использование Gitlab

!!! Для доступа к редактированию документации обратитесь к техническому директору.

Все работы с документацией ведутся в папке /source данного репозитория.

Просомтр документации доступен по этой ссылке.

Перейти к редактированию выбранной страницы можно:

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

  • просто найти необходимую страницу на Gitlab

Перед началом наполнения отдельного документа ознакомьтесь с синтаксисом Markdown который находится вот тут

Основные элементы

Страница на сервисе Gitlab можно условно разделить на 3 основные части:

  1. Шапка;
  2. Сайдбар;
  3. Основной контент.
Шапка

В шапке размещено меню для управления вашим аккаунтом.

Служит для личных настроек и переключения между доступными проектами.

Сайдбар

Меню управления проектом.

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

Основной блок в котором можно переходить по каталогам документации, а так же редактировать отдельные документы.

Переход к редактированию документа

Для редактирвания документа находясь на сервисе можно:

  1. открыть главную страницу проекта;
  2. или в сайдбаре сервиса перейти в пункт Repository.

Далее в блоке с основным контентом, зайти в папку source и выбрать нужную вам папку/файл который вы хотите отредактировать.

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

Нажимаем кнопку Edit и переходим к редактированию файла.

  1. Режим редактирования файла;
  2. Предпросмотр отредактированного файла;
  3. Название Git-ветки в которой находится текущий файл;
  4. Путь к файлу;
  5. Область для редактирования/просмотра содержимого;
  6. Комментарий к изменению;
  7. Название Git-ветки в которую будут сохранены изменения;
  8. Кнопка сохранения изменений;
  9. Кнопка отмены изменений.

Git-ветвление

в разработке

Описание синтаксиса Markdown

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

Markdown не является заменой HTML. Синтаксис Markdown достаточно ограничен, и соответствует лишь небольшому подмножеству элементов HTML. Он включает в себя следующие элементы:

  1. Блочные элементы
  2. Строчные элементы
  3. Дополнительные элементы

Блочные элементы

Параграфы и разрывы строк

Для того, чтобы создать параграф с использованием синтаксиса языка Markdown, достаточно отделить строки текста одной (или более) пустой строкой (пустой считается всякая строка, которая не содержит в себе ничего, кроме пробелов и символов табуляции).
Для того, чтобы вставить видимый перенос строки (элемент <br/>) необходимо окончить строку двумя пробелами и нажатием клавиши «Enter».
Многие элементы синтаксиса Markdown выглядят и работают гораздо лучше в случае, когда их форматируют с помощью «жесткого перевода строк» (разделение строк, осуществленное самим пользователем, а не программой автоматически). К таким элементам относятся цитаты, списки и пр.

Заголовки

Язык разметки Markdown поддерживает 2 стиля обозначения заголовков: подчеркивание и выделение символом («#»).

Выделение заголовков с помощью подчеркивания производится знаками равенства («=») в случае, если заголовок первого уровня, и дефисами («-») в случае, если заголовок второго уровня. Количество знаков подчеркивания не ограничивается.

При выделении заголовков с помощью символа («#») используется от одного до шести данных символов, которые устанавливаются в начале строки (перед заголовком). В данном случае количество символов соответствует уровню заголовка. Кроме того, заголовок возможно снабдить закрывающимися символами («#»), хотя это и не является обязательным. Количество закрывающихся символов не обязано соответствовать количеству начальных символов. Уровень заголовка определяется по количеству начальных символов.Заголовки первого и второго уровней, выполненные с помощью подчеркивания, выглядят следующим образом:

Заголовок первого уровня
========================
Заголовок второго уровня
-------------------------

Заголовки первого, третьего и шестого уровней, выполненные с помощью символа («#»), выглядят следующим образом:

#  Заголовок первого уровня
### Заголовок третьего уровня
###### Заголовок шестого уровня

Приведенные выше заголовки, выполненные с помощью символа («#») тождественны следующим:

#  Заголовок первого уровня #
### Заголовок третьего уровня ###
###### Заголовок шестого уровня ######

Заголовк со идентификатором пишем так:

### Заголовок с идентификатором <header-with-id>
[ссылка на заголовок с идентификатором](#header-with-id)

Указание <header-with-id> обязательно по причине того что мы ведем документацию на русском языке и я пока не нашел способа формировать id заголовков иным образом, сделано это исключительна для более удобной навигации

Цитаты

Для обозначения цитат в языке Markdown используется знак «больше» («>»). Его можно вставлять как перед каждой строкой цитаты, так и только перед первой строкой параграфа. Также синтаксис Markdown позволяет создавать вложенные цитаты (цитаты внутри цитат). Для их разметки используются дополнительные уровни знаков цитирования («>»). Цитаты в Markdown могут содержать всевозможные элементы разметки. Цитаты в языке Markdown выглядят следующим образом:

>Это пример цитаты,
>в которой перед каждой строкой
>ставится угловая скобка.

>Это пример цитаты,
в которой угловая скобка
ставится только перед началом нового параграфа.
>Второй параграф.

Вложение цитаты в цитату выглядит следующим образом:

> Первый уровень цитирования
>> Второй уровень цитирования
>>> Третий уровень цитирования
>
>Первый уровень цитирования

В результате на экран выводится следующее:

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

Вложенная цитата:

Первый уровень цитирования

Второй уровень цитирования

Третий уровень цитирования

Первый уровень цитирования

Уровень цитирования не может превышать 15-й.

Списки

Markdown поддерживает упорядоченные (нумерованные) и неупорядоченные (ненумерованные) списки.Для формирования неупорядоченный списков используются такие маркеры, как звездочки, плюсы и дефисы. Все перечисленные маркеры могут использоваться взаимозаменяемо.Для формирования упорядоченных списков в качестве маркеров используются числа с точкой. Важной особенностью в данном случае является то, что сами номера, с помощью которых формируется список, не важны, так как они не оказывают влияния на выходной HTML код. Как бы ни нумеровал пользователь список, на выходе он в любом случае будет иметь упорядоченный список, начинающийся с единицы (1, 2, 3…). Эту особенность стоит учитывать в том случае, когда необходимо использовать порядковые номера элементов в списке, чтобы они соответствовали номерам, получающимся в HTML. Упорядоченные списки всегда следует начинать с единицы. Маркеры списков обычно начинаются с начала строки, однако они могут быть сдвинуты, но не более чем на 3 пробела. За маркером должен следовать пробел, либо символ табуляции. При необходимости в список можно вставить цитату. В этом случае обозначения цитирования ( «>» ) нужно писать с отступом. Упорядоченные списки выглядят следующим образом:

1.  Проводник
2.  Полупроводник
3.  Диэлектрик

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

* Проводник
* Полупроводник
* Диэлектрик

Или

- Проводник
- Полупроводник
- Диэлектрик

Или

+ Проводник
+ Полупроводник
+ Диэлектрик

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

  1. Проводник
  2. Полупроводник
  3. Диэлектрик

и

  • Проводник
  • Полупроводник
  • Диэлектрик

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

1. Элемент списка с цитатой:

    > Это цитата
    > внутри элемента списка.

 2. Второй элемент списка

В результате на экран выводится следующее:

  1. Элемент списка с цитатой:

    Это цитата внутри элемента списка.

  2. Второй элемент списка

При вставке цитат в элементы списка важно учитывать, что элементы списка должны находиться на одном уровне, а цитаты должны указываться с отступом. В случае, если правило с единым уровнем списка не соблюдается, следующий после цитаты элемент списка будет автоматически нумероваться цифрой «1.». Кроме того, при необходимости в список можно вставить исходный код. В этом случае его нужно писать с двойным отступом – 8 пробелов или 2 символа табуляции.

  • Элемент списка, содержащий исходный код

    <исходный код >

Блоки кода

Отформатированные блоки кода используются в случае необходимости процитировать исходный код программ или разметки. Для создания блока кода в языке Markdown необходимо каждую строку параграфа начинать с отступа, состоящего из четырех пробелов или одного символа табуляции. Блок кода продолжается до тех пор, пока не встретится строка без отступа (или конец текста). Внутри блока кода амперсанды («&») и угловые скобки («<» и «>») автоматически преобразуются в элементы HTML разметки. Кроме того, следует отметить, что внутри блоков кода обычный синтаксис Markdown не обрабатывается. Блок кода в Markdown выглядит следующим образом:

Это обычный параграф:

Это блок кода
Горизонтальные линии (разделители)

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

Первая часть текста, который необходимо разделить
***
Вторая часть текста, который необходимо разделить

Или

Первая часть текста, который необходимо разделить

---

Вторая часть текста, который необходимо разделить

В результате на экран выводится следующее:

Первая часть текста, который необходимо разделить

Вторая часть текста, который необходимо разделить

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

Строчные элементы

Выделение текста

Markdown воспринимает звёздочки «*» и символы подчёркивания «_» как признаки смыслового выделения текста:

  • Текст, окружённый одиночными «*» или «_», будет заключен в HTML-тэг <em>.
  • Текст, окружённый двойными «*» или «_», будет заключен в HTML-тэг <strong>.

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

Пример

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

**Пример**

Пример

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

***Пример***

Пример

Все приведенные выше примеры аналогичны следующим:

_Пример_

__Пример__

Пере___распред___деление

___Пример___
Кодовые фрагменты строк

Чтобы отметить фрагмент строки, содержащий код, необходимо окружить его обратными апострофами «`».При использовании кодовых фрагментов строк текст будет отображаться в виде моноширинного шрифта. В отличие от блоков кода, кодовый фрагмент позволяет поместить код внутрь обычного абзаца текста. Кодовый фрагмент строки в языке Markdown выглядит следующим образом:

Используйте оператор if

Изображения

В Markdown существует 2 способа вставки изображений в документ:

a. С помощью непосредственного указания URL-адреса изображения. Синтаксис данной команды выглядит следующим образом:

![Альтернативный текст](/путь/к/изображению.jpg)

или

![Альтернативный текст](/путь/к/изображению.jpg "Подсказка")

Альтернативный текст

Иными словами, он состоит из следующих элементов:

  • восклицательный знак;
  • квадратные скобки, в которых указывается альтернативный изображению текст (он станет содержимым атрибута в элементе img);
  • круглые скобки, содержащие URL-адрес или относительный путь изображения, а также (необязательно) всплывающую подсказку, заключённуе в двойные или одиночные кавычки.

b. С помощью метки-идентификатора. Синтаксис данной команды записывается следующим образом:

![Альтернативный текст][id]

где «id» — имя определённой метки изображения. Метки изображений определяются при помощи синтаксиса, совершенно идентичного меткам гиперссылок:

[id]: путь/к/изображению "Необязательная подсказка"

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

Дополнительные элементы

Обратный слеш

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

«\» - слеш;

«`» - обратный апостроф;

«*» - звездочка;

«_» - символ подчеркивания;

«{}» - фигурные скобки;

«[]» - квадратные скобки;

«()» - круглые скобки;

«#» - символ решетки;

«+» - плюс;

«-» - минус (дефис);

«.» – точка;

«!» - восклицательный знак.

Специальные символы

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

&lt;

») и («

&amp;

»). Левая угловая скобка используется как начало тэга; амперсанды применяются для обозначения специального символа HTML. Для того чтобы использовать эти символы в их буквальном смысле, необходимо заменить их элементами HTML, а именно &lt; и &amp; соответственно. При использовании Markdown подобных действий совершать не нужно. Он позволяет использовать эти символы в исходном виде. В случае если амперсанд используется как часть спецсимвола HTML, он останется неизменным. В противном случае Markdown преобразует его в &amp;.

Требования к сайту и программному обеспечению

Дизайн сайта

Пользователи

Пользователи (сайт)

Группы пользователей

На сайте на текущий момент имеется 3 основные группы пользователей:

  1. Гость;
  2. Пассажир;
  3. Независимый водитель.
Гость

Гость (не зарегистрированный/авторизованный пользователь) - это любой пользователь не прошедший регистрацию на сайте и ли не авторизовавшийся.

Для это группы пользователей недоступно большинство функций на сайте.

Для гостя доступно:

Просмотр страниц сайта не требующих авторизации:

Пассажир

Пассажир - это пользователь прошедший регистрацию как пассажир и авторизован на момент нахождения на сайте.

Для пассажира на сайте доступно:

  1. Все страницы для гостя;
  2. Доступ к Офису пассажира;
  3. Создание/сохранение/оплата заявки;
  4. Внутренний счет на сайте с возможностью вносить на него деньги и снимать;
  5. История финансовых операций на сайте;
  6. Прочтение внутренних сообщений от системы.
Независимый водитель

Независимый водитель - это пользователь прошедший дополнительную регистрацию как независимый водитель и авторизован на сайте.

Для независимого водителя на сайте доступны:

  1. Все страницы для гостя;
  2. Все страницы доступные пассажиру;
  3. Доступ к Офису независимого водителя;
  4. Доступ к подключению и участию в партнерских программах.

Уровни доступа для пользователей

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

Пользователи (админ панель)

Группы пользователей

Уровни доступа для пользователей

Страницы сайта

Карта сайта

Главная страницы

Главная страница

Размещение заявки на биржу

  1. На главной *
  2. В офисе пассажира *
  3. Проверка и подтверждение завки **
  4. Оплата завки **
  5. Редактирование завки **

*3 шага на одном url
**id заявки в конце ссылки меняется

Офис пассажира

  1. Главная, создание заявки (3 шага создания заявки)
  2. Open orders
  3. All orders
  4. Профиль пассажира на всех страницах офиса в модальном окне.

Офис независимого водителя

  1. Find order
  2. Open orders
  3. All orders
  4. Профиль независимого водителя на всех страницах офиса в модальном окне.

Страницы помощи

  1. How it work?
  2. FAQs
  3. Guides

Для каждой страницы есть вкладка для пассажира и для водителя.

Информационные страницы

  1. О нас
  2. Profit
    Вкладки:
    1. Profit passenger
      1. Business group
      2. Pets
      3. Add services
      4. Spec. Drivers
    2. Profit drivers
      1. Weekly profit
      2. 5000 profit
      3. Extra
      4. Extra money
  3. Блог
    Категории/подкатекогрии:
    1. TMP Life
      1. TMP News
      2. International money and people
      3. GEO TMP info
    2. For Passenger
      1. News for passangers
      2. Local money
      3. Local info for passanger
    3. For Driver
      1. News for drivers
      2. Local money and driver
      3. Local info for driver

Внутренние сообщения (Notifications)

  1. Все сообщения
  2. TMP Market
  3. TMP Store
  4. My Wallet
  5. Basket

Магазин

Страницы магазина в разработке

Каркас сайта

Блок под шапкой

Блок под шапкой вспомогательный. В нем размещены:

  1. Хлебные крошки;
  2. Ссылка на страницу партнерских программ;
  3. Блок notiffication (внутренние уведомления).
Хлебные крошки

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

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

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

Notiffication

Ссылка для перехода на страницу внутренних уведомлений системы /notifications а так же счетчик непрочитанных уведомлений.

Баннер

в разработке

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

Размещается сразу под шапкой.

На текущий момент статическое размещение, в дальнейшем будет ротатор банеров управляемый из административной панели

Контент

Основной контент страницы. Размещение между банером и подвалом сайта.

Блок соц сетей

в разработке

временно используется как болк “Поделиться”

Блок соц. сете создан для перехода на посты разных соцсетях размещенных на нашем сайте.

Данный блок включает в себя 4 соц. сети:

  1. Twitter;
  2. Google+;
  3. Facebook;
  4. Youtube.

Копирайт

В этом блоке указан текущий год и наш копирайт ©

Главная страница

Описание

Главная страница - это витрина сайта. На ней расположены 2 основных рабочих инструмента для пользователей.

  1. 2 ссылки/кнопки;
  2. Шаги оформления завки для пассажира;
  3. Биржа с размещенными завками для водителя.
Шаги оформления завки

Модуль предназначен для создания поездки пассажиром. Описание работы на этой странице.

Биржа

Модуль предназначен покупки размещенной завки водителем. Описание работы на этой странице.

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

Регистрация и авторизация

Регистрация пассажира

Офис пассажира выдается всем пользователям сайта при регистрации.

Для регистрации пользователя на сайте в роли пассажира нужно перейти на страницу регистрации нажав на кнопку "Hello, Log in" в шапке сайта и на открывшейся странице нажать кнопку "Sign Up".

Шаг 1 (ввод контактной информации)

На открывшейся странице необходимо заполнить все поля.

Правила заполнения:

  1. Поля заполняются только латиницей;
  2. Возле каждого поля подсказка, при наведении на которую всплывает поясняющий текст к полю ввода;
  3. Поля для воода пароля имеют два вида отображения:
    1. Стандартный вид со знаками * вместо символов;
    2. При нажатии на надпись "Show" пароль отображается обычным текстом.
  4. Проверку корректности заполнения формы не делаем (оставляем на усмотрение пользователя).
  5. Проверка на заполненность делаем стандартными средствами браузера. То есть добавляем к полям атрибут required. В результате чего при пустом поле пользователь видит подсказку, о том что данное поле обязательно для заполнения на своем языке.
Шаг 2 (проверка и соглашение с правилами)

Страница подтверждения введенных данных при регистрации.

На данной странице пользователь должен подтвердить корректность введенных данных в форму при регистрации.

А так же согласиться с условиями и правилами работы нашего сервиса отметив специальное поле.

Так же пользователь имеет возможность ознакомиться с ними нажав на Terms and Conditions и Privacy policy.

Terms and Conditions и Privacy policy после нажатия появляются во всплывающем окне на текущей странице.

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

Так же на данной странице пользователь может перейти на страницу редактирования своих данных нажав кнопку "Edit" которая переведет его на предыдущий шаг.

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

Шаг 3 (проверка или смена почты)

На 3-ем шаге пользователь выидит сообщение о том что ему отправлено на почту письмо для активации аккаунта.

На это странице пользователь может:

  1. отправить повторно писмо себе на почту нажав на ссылку "Didn't get your verification email?"
  2. сменить почтовый ящик и отправить на него письмо активации нажав на ссылку "Used the wrong email address?" после чего откроется дополнительное поле для ввода новой почты и кнопкой для отправки нового письма.

Шаг 4 (активация аккаунта)

Для активации аккаунта система высылает пользователю письмо на email адрес указанный при регистрации.

Для активации аккаунта пользователь должен нажать на кнопку "Activation" в полученном письме. Ссылка для поддтверждения уникальна и генерируется автоматически. То есть:

  1. ни кто другой не сможет зарегистрироваться по этой ссылке;
  2. активировать по этой ссылке можно только 1 аккаунт в системе.

После перехода по ссылке из писма, пользователь попадет на страницу с приветственным сообщением и выбором дополнительных офисов.

На этой странице пользователь может перейти в офис пассажира нажав на стилизованную ссылку "Passenger office" или перейти к регистрации дополнительного офиса нажав на кнопку "Free trial" в блоке с описанием другого офиса.

Сброс пароля

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

Для этого нужно перейти на страницу авторизации /login И нажать на ссылку "Forgot your password?". После нажатия пользователь попадет на страницу восстановления пароля где нужно ввести свой email адрес и нажать на кнопку "Reset password".

Система отправит письмо пользователю на email а на странице сайта отобразится сообщение о том что письмо отправлено.

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

Нажав на кнопку "Reset password" в письме, пользователь попадет на страницу где ему нужно ввести новы пароль, подтвердить его введя повторно и нажать кнопку "Change password". После чего пользователь сможет войти на сайт с новым паролем.

Проверок корректности или проверка на совпадение со старыми паролями не делается.

Смена пароля

Смену пароля реккомендуется системой раз в 3 месяца.

Уведомление об этом выводится в кабинете пассажира в окне с профилем пользователя. Открыть которое можно перейдя на любую страницу офиса пассажира и нажав кнопку "My profile".

Для смены пароля пользователю необходимо ввести старый пароль и дважды ввести новый.

Проверок корректности или проверка на совпадение нового пароля со старыми не делается.

Внешний вид полей для ввода паролей имеет 2 варианта внешнего вида:

  1. Стандартный вид со знаками * вместо символов;
  2. При нажатии на надпись "Show" пароль отображается обычным текстом.

Регистрация независимого водителя

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

На страницу дорегистрации пользователь может попасть 2-мя способами:

  1. Открыть меню аккаунта наведя на кнопку "Hello, Имя Фамиля" в шапке сайта и выпадающем меню нажать на кнопку "Get new ofice"
  2. Находясь в офисе пассажира нажать кнопку "Get PRO office"

На странице выбора офиса /choose-office в блоке "Independent Driver's Office" нажать кнопку "Free trial" и перейти к заполнению профиля водителя.

Заполнение профиля водителя

На странице регистрации независимого водителя есть 5 обязательных для заполнения поля, необязательное поле Skype и дополнительные элементы.

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

Обязательные поля отмечены символом '*':

  1. Country - страна нахождения водителя с выбором вырианта из выпадающего списка;
  2. City of registration - город регистрации с выбором вырианта из выпадающего списка;
  3. English - уровень владения английским языком с выбором вырианта из выпадающего списка;
  4. Driving experience - опыт вождения автомобиля с выбором вырианта из выпадающего списка;
  5. Mobile - номер мобильного телефона.

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

Для выбора уровня владения английским языком список формируется исходя из общепринятого разделения:

  1. No
  2. Elementary
  3. Pre-Intermediate
  4. Intermediate
  5. Upper-Intermediate
  6. Advanced
  7. Proficiency

Кнопка "Add language" добавляет необязательное поле для выбора дополнительного языка которым владеет пользователь. Можно добавить 2 дополнительных языка. А так же удалить если поле было создано по ошибке.

Опыт вождения имеет 2 варианта для выбора:

  1. less than 4 years
  2. more than 4 years

Поле Skype, необязательное и заполняется по желанию пользователя.

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

Дополнительно пользователь может указать использует ли он интернет на этом телефоне выбрав internt и есть ли у него whatsapp привязанный к данному номеру телефона. Данные поля не обязательны.

Так же можно добавить дополнительный номер телефона нажав на ссылку "Add mobile". После нажатия появится аналогичный блок с полем ввода номера телефона и выбора дополнений internet и whatsapp для нового номера телефона.

Подтверждение заполненного профиля

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

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

Заполнение информации о автомобиле

После нажатия на кнопку "Complete" пользователь переходит в офис независимого водителя /office-driver.

Так же ситема отправляет пользователю письмо на email о получени им нового офиса, по ссылке из письма он так же может попасть в свой новый офис.

При входе в офис независимого водителя высплывает окно профиля с открытой вкладкой с информацией о автомобиле в которм водитль должен заполнить обязательные поля обозначенные символом "*":

  1. Brand - марка автомобиля;
  2. Model - модель автомобиля;
  3. Year - год выпуска;
  4. Color - цвет;
  5. Number plate - регистрационный номер автомобиля;
  6. Class - класс автомобиля;

Поля Brand и Model заполняются по порядку. Сначала выбирается марка автомобиля и согласно выбору наполняется список моделей авто.

Необязательные поля:

  1. Other - иныормация о количестве мест для пассажиров, мест для багажа и количество дверей автомобиля.
  2. Short description - красткое описание автомобиля которое водитель хочет оставить. Для данного поля есть ссылка "example" при нажатии на которую описание заполняется автоматически шаблонным текстом.
Окончание регистрации

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

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

Офисы

Офис пассажира

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

Офис пассажира выдается всем зарегистрировавшимся в нашей системе бесплатно.

Возможности офиса

В офисе пассажира пользователь может:

  1. создавать заявки:
  2. редактировать свои заявки;
  3. удалять свои заявки;
  4. оплачивать свои заявки;
  5. следить за состоянием своих заявок;
  6. выбирать откликнувшихся водителей или удалять их из заявки;
  7. писать отзывы о водителе после выполнения заявки;
  8. жаловаться на водителя после выполнения завяки; в разработке *
Описание

Офис пассажира состоит из 3-х основных блоков:

  1. Блок с баннером;
  2. Информационная панель;
  3. Управление завками.
Блок с баннером

в разработке

Информационная панель

Описание данного блока можно посмотреть по ссылке.

Управление заявками

Управление завками состоит из 3-х блоков. Каждый блок расположен на отдельной странице и имеет свой url.

  1. Book your trip - страница создания новой завки /office-passenger;
  2. Open orders - страница управления открытыми заявками /office-passenger/open-orders;
  3. All orders - страница истории завок /office-passenger/all-orders.
Book your trip

Описана на странице создания завки.

Open orders

На данной странице пассажир может просматривать созданные завки в статусах before-open, open и pending.

А так же выбирать, просматривать и удалять водителей из заявки.

В строке с заявкой для разных статусов отображаются:

  1. Порядковй номер заявки;
  2. Id заявки в системе;
  3. Маршрут заявки;
  4. Блок с кнопками для управления завкой;
  5. Выпадающий блок с информацией о водителях откликнувшихся на заявку.
Маршрут заявки

При клике на маршрут заявки на текущей странице открывается высплывающее окно с информацией о завке в котором расположены:

ссылка на описание блока

Состояние завки before-open - это состояние когда заявка создана, но не оплачена.

Отличие от других состояний завки - 2-е кнопки "Pay" и "Edit".

При нажатии на кнопку "Edit" пользователь перенаправляется на страницу редактирования заявки ссылка.

При нажатии на кнопку "Pay" пользователь перенаправляется на страницу оплаты заявки.

Состояние завки open - это состояние когда заявка создана и оплачена.

Отличие от других состояний завки - наличие не активной кнопки "Driver list"

Состояние завки pending - это состояние когда заявка создана и оплачена и на неё откликнулся хотя бы один водитель.

Максимальное количество водителей которые выводятся на странице Open orders - 5
в дальнейшем количество водителей расширится

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

На кнопке "Driver list" выводится количество откликнувшихся водителей.

При нажатии на кнопку надпись "Driver list" меняется на "Hide drivers list" и ниже появляется список водителей в котором расположены:

  1. Блок с информацией о водителе где выводится:
    • фото водителя;
    • фамилия и имя водителя;
    • роль в системе;
    • количестов отзывов о водителе;
    • рейтинг водителя в виде звезд;
    • уровень владения английским языком.
  2. Блок с информацией об автомобиле где выводится:
    • фото автомобиля;
    • марка и модель автомобиля;
    • количество пассажиров, багажных мест и дверей автомобиля.
  3. Блок с кнопками которые предназначены:
    • Accept - для выбора водителя;
    • Deny - для удаления водителя из заявки.
Информация о водителе

При клике на фамилию водителя откроется окно с подробной информацией о водителе.

В окне с информацией о водителе 5 основных блоков:

  1. About driver - подробная информация о водителе: (открыт по умолчанию можно закрыть при клике на заголовок)
    1. ID водителя;
    2. Имя водителя;
    3. Фамилия водителя;
    4. Страна проживания;
    5. Город проживания;
    6. Уровень владения английским языком, если водителем указаны дополнительные языки то их список выводится ниже;
    7. Опыт вождения (меньше или больше 4-х лет);
    8. Визуальный блок:
      1. Фотография водителя;
      2. Рейтинг водителя в виде звезд(пяти бальная система);
      3. Количество отзывов о водителе.
  2. About car - подробная информация об автомобиле: (можно открыть при клике на заголовок)
    1. Марка автомобиля;
    2. Модель автомобиля;
    3. Год выпуска автомобиля;
    4. Цвет автомобиля;
    5. Регистрационный номер автомобиля;
    6. Класс автомобиля;
    7. Дополнительная информация об автомобиле:
      1. Количество пассажиромест;
      2. Количество багажных мест;
      3. Количество дверей у автомобиля;
    8. Короткое прозвольное описание об автомобиле.
  3. Reviews - отзывы о водителе: (можно открыть при клике на заголовок)
    1. Выводятся строками 5 штук при первоначальной загрузке;
    2. Если отзывов больше 5 под ними выводится кнопка "More", при нажатии на которую подгружаются дополнительные отзывы по 5 штук. Если отзывов больше нет, то кнопку "More" прячем.
    3. В строке с отзывом:
      1. Имя, фамилия пассажира;
      2. Дата отзыва;
      3. Текст отзыва.
  4. Driver contacts - контактная информация водителя, которая становится доступна после заключения сделки между пассажиром и водителем: (можно открыть при клике на заголовок)
    1. Номер одного или более телефона водителя указанных им при регистрации.
    2. Елси к номерам телефонов привязан watsapp то выводится информация об этом рядом с телефоном.
    3. Адрес электронной почты водителя;
    4. Логин в Skype водителя.
  5. Кнопки управления окном:
    • крестик в верхнем правом углу окна, служит для закрытия окна без каких либо действий с водителем;
    • кнопка "Accept" - для выбора текущего водителя;
    • кнопка Deny - для удаления текущего водителя из заявки.
Open orders

На данной странице выводятся заявки во всех статусах.

Страница служит:

  1. для контроля за заявкой;
  2. для перехода к редактированию заявки;
  3. для удаления завки;
  4. для перехода к написанию отзыва о водителе после завершения завки.

Завки выводятся в виде таблицы построчно.

Описание колонок:

  1. Порядковый номер;
  2. ID заявки в системе ТМР;
  3. Дата начала поездки;
  4. Просмотр маршрута поездки;
  5. Стоимость поездки без учета чаевых;
  6. Status:
    1. До заключения сделки выводится только статус;
    2. После заключения с водителем сделаки дополнительно выводится аватар водителя при клике на который появляется окно с информацией о нем с контактными данными.
    3. После окончания поездки выводится кнопка "review", нажав на которую можно оставить отзыв о водителе и поездке. Окно состоит из:
      1. Рейтинга в виде звезд. При клике закрашивается выбранное количество (от 1-ой до 5-и)
      2. Текстовое поле для отзава. Ограничение в 300 символов;
      3. Кнопки "Send review", если тектовое поле не заполнено или не выбран рейтинг, подсвечиваем пустой элемент, форму не отправляем;
  7. Время оставшееся до начала завки;
  8. Блок "Edit" с кнопками:
    1. Кнопка для редактирования завки (открываетсяв новом окне);
    2. Кнопка для удаления завки (после нажатия нужно подтвердить удаление или отказаться от удаления во всплывающем окне).

Офис независимого водителя

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

Офис водителя выдается всем зарегистрировавшимся в нашей системе в роли независимого водителя.

Возможности офиса

В офисе независимого водителя пользователь может:

  1. создавать заявки:
  2. редактировать свои заявки;
  3. удалять свои заявки;
  4. оплачивать свои заявки;
  5. следить за состоянием своих заявок;
  6. выбирать откликнувшихся водителей или удалять их из заявки;
  7. писать отзывы о водителе после выполнения заявки;
  8. жаловаться на водителя после выполнения завяки; в разработке *
Описание

Офис независимого водителя состоит из 3-х основных блоков:

  1. Блок с баннером;
  2. Информационная панель;
  3. Управление завками.
Блок с баннером

в разработке

Информационная панель

Описание данного блока можно посмотреть по ссылке.

Блог TMP

Назначение и задачи блога

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

Он выполняет следующие функции:

Привлекает целевых клиентов из поисковых систем.

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

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

Привлекает потенциальных клиентов из соц.сетей и блоговых систем.

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

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

Информационная функция. Новые и повторные продажи.

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

SEO продвижение.

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

Эффективное использование ключевых слов, поиск ключевых запросов и анализ поисковой выдачи, написание статей, особенно по недостаточно удовлетворенным запросам, способствует впоследствии попаданию статей в ТОП поисковой выдачи. А это самый дешевый способ получения потенциальных клиентов.

Информационная поддержка.

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

Повышает уровень доверия к проекту.

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

Новые пользователи, увидев количество отметок Useful (полезность статьи) и положительные комментарии, также будут относиться к информации с большим доверием.

Сохраняет нужную информацию.

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

Усиливает бренд.

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

Описание страниц блога

(в разработке)

Требования к блогу

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

У всех страниц блога должен быть отдельный URL для входа на статью:

  1. из поисковиков по ключевым словам;
  2. из наших страниц в соц.сетях, где будет публиковаться анонс на статью;
  3. со страниц соц.сетей пользователей, которые ей поделились;
  4. с блогов/видео блогов/страниц соц.сетей наших партнеров, которые нас рекламируют и отправляют людей на наш сайт;
  5. для ознакомления пользователя по рекоммендации службы поддержки;
  6. из возможной рассылки подписанных пользователей.
Главная страница

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

На главной странице блога есть 4 основных блока:

  1. Блок категорий;
  2. Блок со списком статей;
  3. Кнопка More под списком статей;
  4. Блок со сквозными ссылками.

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

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

При нажатии кнопки More выводятся дополнительные статьи в виде плитки под списком сатей.

Категории блога

На текущий момент блог делится на 3 основных категории в каждой из которых 3 подкатегории.

  1. TMP Life
    1. TMP News
    2. International money and people
    3. GEO TMP info
  2. For Passenger
    1. News for passangers
    2. Local money
    3. Local info for passanger
  3. For Driver
    1. News for drivers
    2. Local money and driver
    3. Local info for driver

Блок категорий состоит из 3-х блоков:

  1. Переключатель основных категорй;
  2. Блок с названием основной категории;
  3. Переключатель подкатегорий.

При нажатии на одину из категорий в списке статей без перезагрузки страницы выводится список статей выбранной категории.

Список статей

При загрузке страницы или при переключении категории выводится список статей в виде плитки, по 3 статьи в ряд. Максимальное количество при загрузке страницы 9 статей.

Под списком расположена кнопка "More" при нажатии на которую под список статей выводятся другие статьи соответствующие выбранной категории/подкатегории. Полсе каждого нажатия выводится до 9-и статей. Если статей в текущей категории/подкатегории больше чем выведено после нажатия на "More", то кнопка остается видимой и можно нажимать её еще раз. Если статей осталось 9 или меньше, кнопка "More" скрывается.

Разные категории в списке статей выделяются своим цветом. Название статьи выделяется цветом соответствующим категории.

Элемент списка

Элемент списка - это краткая информация о статье.

Он содержит:

  1. Картинка с иконками (является ссылкой на страницу статьи);
  2. Рубрика (является ссылкой на страницу определенной рубрики;
  3. Название статьи (является ссылкой на страницу статьи);
  4. Дата публикации;
  5. Регион, к которому привязана статья (весь мир, определенная страна, город) (Регион является ссылкой на страницу статей, привязанных к определенному региону). "пока не делаем"

При наведении над каждой картинке в списке статей появляется затемненный прозрачный фон.
На данном фоне появляются иконки:

  1. Иконка "Добавить в мою библиотеку" - знак "+" в кружочке - в левом вехнем углу + надпись "direct to your Library";
  2. Иконка "Useful" - двуцветная "+" (красно-зеленый) и количество пользователей, отметивших статью полезной - в левом нижнем углу - временно неактивна;
  3. Иконка комментария и количество комментариев - в правом нижнем углу.

Иконка "Useful"

При нажатии на иконку она окрашивается в цвет рубрики, которой принадлежит статья (голубой, красный или синий), и данная выбранная статья появляется также во вкладке блога My Library.

При повторном нажатии цвет иконки возвращается в исходный. И она уходить из вкладки пользователя My Library.

Страница статьи

Пример структуры страницы статьи при загрузке страницы

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

  1. Логотип сайта;
  2. Название статьи;
  3. Блок "Поделиться".

Структура статьи (в порядке размещения на странице):

  1. Название категории;
  2. Заголовок статьи;
  3. Дата публикации
  4. Регион;
  5. Блок "Поделиться";
  6. Картинка или видео;
  7. Текст статьи;
  8. Кнопка Useful (полезно);
  9. Сквозные ссылки для пассажира, перевозчика и партнера;
  10. Комментарии;
  11. Блок Related articles (Статьи по теме) - 6шт.
Название категории

Название категории выводится в самой верхней части страницы.

Заголовок статьи

Заголовок статьи при загрузке страницы выводится в верхней части страницы под категорией статьи.

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

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

Дата публикации

Дата выводится над изображением статьи в формате "месяц день, год". Например - December 1, 2017.

Регион "в разработке"

В этот блок выводим регион для которого размещена статья. Это может быть весь мир, страна или город.

Блок размещается справа от даты публикации.

Картинка или видео

На странице статьи выводится или тематическое изображение или видео.

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

Текст статьи

Текст статьи выводится под изображением статьи.

Размер статей на сайте не превышает 12000 символов.

Статьи по размеру 4-х типов:

  1. Маленькие статьи - до 1000 знаков
  2. Средние статьи - от 1000 до 3000 знаков
  3. Большие статьи - от 3000 знаков
  4. Максимум - 12000 знаков
Кнопка Useful "в разработке"

!!! Временно не размещаем. Вернемся к ней минимум через 6-12 месяцев(июнь-декабрь 2018)

Под статьей размещается кнопка Useful, чтобы пользователь смог отметить, что статья была полезной для него.

Нажате на кнопку увеличивает счетчик (люди которые посчитали статью полезной), повторное нажатие уменьшает.

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

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

Все комментарии проходят модерацию.

В каждом комментарии отображается:

  1. Аватар комментатора;
  2. Дата комментария;
  3. Текст комментари;
  4. Ответ модератора (если есть).

После загрузки страницы выводится до 5-и комментариев.

Под блоком с комментариями если их больше 5-и показываем кнопку More со счетчиком оставшихся комментариев. Например More(35). При нажатии на неё добавляются еще 5 комментариев. Если осталось 5 или меньше коментариев кнопка More скрывается.

Ответы на комментарии "в разработке"

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

Написание комментариев

Под блоком с комментариями выводим текстовое поле для написания комментария. Ограничение 250 символов. Под полем Расположен счетчик символов который при вводе уменьшается. Под строкой со счетчиком символов, расположена кнопка Add при нажатии на которую коментарий отправляется на модерацию. И полльзователю выводится сообщение об этом.

Редактирование комментариев "в разработке"

В течении получаса пользователь должен иметь возможность отредактировать свой комментарий нажав ссылку Edit под своим комментарием.

Блок "Поделиться"

Блок "Поделиться" (Кнопки соц.сетей) - предназнаечен для того чтобы пользователь мог поделиться понравившейся статьёй через свою социальную сеть.

Список необходимых ссылок:

  1. facebook;
  2. twitter;
  3. google+;
  4. vk;
  5. email (отправка ссылки статьи на email);
  6. копировать ссылку (копирование ссылки на статью в один клик).

Блок распологается на странице со статьёй.

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

После начала прокрутки страницы блок переносится в шапку справа. При прокрутке к началу страницы блок "Поделиться" возвращается в исходное состояние.