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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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