Courier Service Account

Назначение

Регламент по созданию/редактированию статей предназначен для сотрудников "MeaSoft", которые будут работать с контентом на сайте wiki.courierexe.ru.

Иерархия

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

Подготовка

1. Необходимо изучить статьи Википедии по работе со статьями. Начать можно с прочтения Создание статьи, Оформление статей. Необходимую информацию по шаблонам, так же, можно найти на Википедии.
2. Статья-пример, которая демонстрирует структурные правила и особенности наполнения - Мобильное приложение курьера для IPhone.
3. Не будет лишним посмотреть обычные статьи Википедии, чтобы понять основной принцип – единообразие структуры, наполнения и оформления.

Структура

1. Прежде чем приступать к написанию/корректировке статьи, необходимо узнать логическую цепочку процесса и причинно-следственные связи в программе.
2. Если создается новая статья, то оптимальным будет - создание «Скелета» (набор заголовков, которые покажут общую картину и помогут последовательно или одновременно наполнять разделы статьи контентом).
3. Обратите внимание, заголовок должен четко отражать сущность написанного в блоке, быть логичным и корректно сформулированным. Пример: заголовок- «Выбор картографической системы», изначально был – «Взаимодействие модуля «Карты» с картографическими системами» сама статья.
4. Важно учитывать логические связи между заголовками и подзагаловками. Для этого необходимо выстраивать связи – от общего к частному. Желательно, соблюдать логику действия пользователя, чтобы помочь пройти путь от начала до конца.

Наполнение

1. После заголовка необходимо описать что это, затем необходимо рассказать о задачах, которые решает функционал, если из их описания это не понятно, а затем об опыте использования или о полезных "фишках".
2. Наполнение должно быть актуальным и отражать реальное положение дел, на данный момент. Если есть информация, в которой нет уверенности или требуется разъяснение, то лучше уточнить.
3. Если же актуальной информации нет, то можно оставить раздел пустым, до момента появления информации (можно оставить запись, что раздел на этапе написания).
4. Большую часть информации можно найти в старых статьях или в интернете, если не получается найти необходимое, то всегда можно задать вопрос.
5. Обратите внимание, что текст будет прочитан обычными людьми, не обладающими профессиональными навыками в программировании или других прикладных дисциплинах, поэтому следует использовать максимально понятный вид изложения.
6. Если в тексте содержатся слова, требующие детального описания, то необходимо добавить их в раздел «Терминология» и сделать ссылку в основной статье. Так же, можно давать внешние ссылки на Википедию, в случае, когда описание подходит под задачи и не требует уточнения.
7. В случае, если раздел статьи получается слишком объемным, то лучше его выделить в отдельную статью.
8. Если же в разделе статьи есть информация технического характера или же информация, которая может пригодиться в ограниченном количестве ситуаций, то ее можно спрятать под спойлер. Пример.
9. Чтобы не описывать информацию, данную ранее или описанную в других статьях – просто укажите на данную информацию ссылку. Википедия.
10. Не используйте собственные ассоциации и сравнения. У каждого человека субъективное восприятие информации, в следствии чего информация может быть понята не верно.

Работа с изображениями

У каждого формата изображения свои предназначения, поэтому, прежде чем выбрать какой-либо формат, будь то .jpeg, .png, .gif, .bmp, прочтите общую информацию о этих форматах. Для простых изображений (с небольшим количеством деталей) лучше подходит .png, т.к. занимает меньше места. Так же стоит учитывать, что одно изображение может решать несколько информационных задач, поэтому подбирать нужно максимально информативное изображение, чтобы не захламлять сервер одноразовыми громоздкими файлами. Немало важным является аккуратность в создании изображения, не стоит загружать некачественно обработанные файлы или не несущие никакой информации.

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