Courier Service Account
Назначение
Регламент создания и редактирования статей включает в себя рекомендации по созданию контента на разных этапах работы.
Подготовка
- Необходимо изучить статьи Википедии по созданию и корректированию публикаций. Начать можно с |Как создать статью и Оформление статей. Необходимую информацию по созданию, оформлению и редактированию статей можно найти на Википедии.
- Статья-пример, которая демонстрирует структурные правила и особенности наполнения - Мобильное приложение курьера для Android.
- Не будет лишним посмотреть обычные статьи Википедии, чтобы понять основной принцип – единообразие структуры, наполнения и оформления.
Структура
- Прежде чем приступать к написанию/корректировке статьи, необходимо узнать логическую цепочку процесса и причинно-следственные связи в программе.
- Если создается новая статья, то оптимальным будет - создание «Скелета» (набор заголовков, которые покажут общую картину и помогут последовательно или одновременно наполнять разделы статьи контентом).
- Обратите внимание, заголовок должен четко отражать сущность написанного в блоке, быть логичным и корректно сформулированным. Пример: заголовок- «Выбор картографической системы», изначально был – «Взаимодействие модуля «Карты» с картографическими системами» сама статья.
- Важно учитывать логические связи между заголовками и подзагаловками. Для этого необходимо выстраивать связи – от общего к частному. Желательно соблюдать логику действия пользователя, чтобы помочь пройти путь от начала до конца.
Наполнение
- Информация в разделах должна быть прикладная. Т.е. после заголовка необходимо описать что это, затем необходимо рассказать о задачах, которые решает функционал, если их описания это не понятно, а затем об опыте использования или о полезных "фишках".
- Наполнение должно быть актуальным и отражать реальное положение дел, на данный момент. Если есть информация, в которой нет уверенности или требуется разъяснение, то лучше спросить, нежели писать ложную информацию.
- Если же актуальной информации нет, то можно оставить раздел пустым, до момента появления информации (можно оставить запись, что раздел на этапе написания). Зачастую, пользователю достаточно посмотреть на заголовки статьи, чтобы найти интересующую его информацию.
- Большую часть информации можно найти в старых статьях или в интернете и если, по каким-то причинам, не получается найти необходимое, то всегда можно задать вопрос.
- Обратите внимание, что текст будет прочитан обычными людьми, зачастую, не обладающими профессиональными навыками в программировании или других прикладных дисциплинах, поэтому следует использовать максимально понятный вид изложения.
- Если в тексте содержаться слова, требующие детального описания, то занесите эти слова в раздел «Терминология» и сделайте ссылку в основной статье. Так же, можно давать внешние ссылки на Википедию, в случае, когда описание подходит под наши задачи.
- В случае, если раздел статьи получается слишком объемным, то лучше его выделить в отдельную статью.
- Если же в разделе статьи есть информация технического характера или же информация, которая может пригодиться в ограниченном количестве ситуаций, то ее можно спрятать под спойлер. Пример.
- Чтобы не описывать информацию, данную ранее или описанную в других статьях – просто укажите на данную информацию ссылку. Википедия.
- Не используйте собственные ассоциации и сравнения. У каждого человека субъективное восприятие информации, в следствии чего информация может быть понята не верно.
Работа с изображениями
У каждого формата изображения свои предназначения, поэтому, прежде чем выбрать какой-либо формат, будь то .jpeg, .png, .gif, .bmp, прочтите общую информацию о этих форматах. Для простых изображений (с небольшим количеством деталей) лучше подходит .png, т.к. занимает меньше места. Так же стоит учитывать, что одно изображение может решать несколько информационных задач, поэтому подбирайте максимально информативное изображение, чтобы не захламлять сервер одноразовыми громоздкими файлами. Немало важным является аккуратность в создании изображения, не стоит вставлять некачественно обработанные файлы или не несущие никакой информации, или же «корявые».
- Прежде чем загружать изображение на сервер убедитесь, что необходимых данных на нем нет. Если вы обнаружили, что данных нет, тогда подберите или создайте подходящее изображение, выгрузите его на сервер, а затем прикрепите к необходимому месту.
- Прежде чем выгружать изображение на сервер проверьте его содержимое, а именно: есть ли на изображении личные данные людей (если вы делаете скриншот из окна программы, то имейте в виду, что в тестовой версии программы есть реальные данные людей, размещение этих данных без их согласия является нарушением закона), реальные фотографии людей, данные существующих организаций и др. данные, подпадающие под закон об информации.
- В Википедии есть статья посвященная изображениям
Расположение статьи
- Когда работа над статьей завершена, стоит еще раз проверить данные, если ошибок и нарушений нет, то необходимо продумать расположением статьи на Заглавной странице.
- В первую очередь необходимо подумать о том, как клиенты будут искать ту или иную информацию на ресурсе. Далее, можно посмотреть на последовательность уже размещенных статей и решить где могла бы располагаться написанная статья. И наконец, разместить "ссылку" на статью, через кнопку "Править".
