Courier Service Account
Содержание
Назначение
Регламент по созданию/редактированию статей предназначен для сотрудников "MeaSoft", которые работают с контентом на сайте wiki.courierexe.ru.
Подготовка
- Изучите статьи Википедии по алгоритму работы с информацией. Начните с прочтения Создание статьи, Оформление статей. Информацию по шаблонам, найдите на Википедии.
- Статья-пример, которая демонстрирует структурные правила и особенности наполнения - Мобильное приложение курьера для IPhone.
- Не будет лишним посмотреть обычные статьи Википедии, чтобы понять основной принцип – единообразие структуры, наполнения и оформления.
Иерархия
- Все статьи в базе знаний представляют иерархическую последовательность от общего к частному. Поэтому каждая статья является частью последовательности и должна продолжать логическую цепочку связей общее-частное.
- Перед созданием статьи определите ее структурное расположение в общей иерархии статей.
- Структура статьи повторяет и является продолжением иерархии статей.
- В первую очередь взгляните на иерархию уже существующих статей, затем определить, где могла бы находиться создаваемая статья.
Структура
- Прежде чем приступать к написанию/корректировке статьи, узнайте логическую цепочку процесса и причинно-следственные связи в программе.
- Заголовки в статьях не должны быть более 3 слов, не считая предлоги и знаки препинания.
- Если создается новая статья, то оптимальным будет - создание «Скелета» (набор заголовков, которые покажут общую картину и помогут последовательно или одновременно наполнять разделы статьи контентом). Зачастую, пользователю достаточно посмотреть на заголовки статьи, чтобы найти интересующую его информацию, даже если наполнения раздела еще нет.
- Обратите внимание, заголовок должен четко отражать сущность написанного в блоке, быть логичным и корректно сформулированным. Пример: заголовок- «Выбор картографической системы», изначально был – «Взаимодействие модуля «Карты» с картографическими системами» сама статья.
- Важно учитывать логические связи между заголовками и подзагаловками. Для этого выстраивайте связи – от общего к частному. Желательно, соблюдать логику действия пользователя, чтобы помочь пройти путь от начала до конца.
Наполнение
- После заголовка описывайте что это, затем рассказывайте о задачах, которые решает функционал, если из их описания это не понятно, а затем об опыте использования или о полезных "фишках".
- Наполнение должно быть актуальным и отражать реальное положение дел, на данный момент. Если есть информация, в которой нет уверенности или требуется разъяснение, то лучше уточнить.
- Если же актуальной информации нет, то оставьтераздел пустым, до момента появления информации (оставьте запись, что раздел на этапе написания).
- Большую часть информации Вы найтдете в старых статьях или у сотрудников "MeaSoft". Вы можете исследовать программное обеспечение самостоятельно.
- Обратите внимание, что текст будет прочитан обычными людьми, не обладающими профессиональными навыками в программировании или других прикладных дисциплинах, поэтому следует использовать максимально понятный вид изложения.
- Не нужно каждый раз делать ссылку на информацию относительно элементов интерфейса (например: основное меню, вкладки, таблицы и подобное). Данное ограничение не касается статей и разделов статей, которые помогают лучше понять работу той или иной функции программы.
- Если в тексте содержатся слова, требующие детального описания, то добавляйте их в раздел «Терминология» и сделать ссылку в основной статье. Вы можете давать внешние ссылки на Википедию, в случае, когда описание подходит под задачи и не требует уточнения.
- В случае, если раздел статьи получается слишком объемным, то разбейте его на подразделы, если получается много подразделов, то имеет смысл создать отдельную статью.
- Чтобы не описывать информацию, данную ранее или описанную в других статьях – просто укажите на данную информацию Ссылку. Статья о ссылках.
- Статья должна состоять из фактов, поэтому не стоит использовать собственные ассоциации и сравнения. Обратите внимание и на изложение, т.к. повествование должно быть беспристрастным, чтобы показать объективную реальность.
- Для начала описания функций в программе нельзя использовать вопросительные слова, такие как: сколько, где, какой, куда и т.д..
- Если требуется показать пользователю расположение функции в программе, то следует использовать оформление следующего вида: "Справочники" -> "Переменные" -> "Сотрудники" -> "Статус курьера по умолчанию:".
- Запрещается использование слова "можно", "необходимо", "активировать".
- Если требуется показать пользователю расположение переменной, то используйте следующее оформление: Статусы писем для расчета остатка на складе. Чтобы посмотреть название переменной в программе, используйте сочетание клавиш "CTRL"+"ALT"+"P".
- Информацию по полям в программе оформляйте следующим образом:
- Описание поля должно начинаться с новой строки, с символа точки-списка (*).
- Не все поля в программе следует заполнять, поэтому изначальная формулировка, используемая для перехода к информации должна быть нейтральной. К примеру: "Рассмотрим карточку" или "В карточке присутствуют следующие поля" и т.д..
- Название каждого поля должно быть оформлено с использованием жирного курсива, для удобства поиска и прочтения информации.
- Описания каждой функции должны разделяться ".".
- Пояснение функции/поля должно быть лаконичным и понятным читателю (что это и для чего это). Если объем получается значительным, то имеет смысл создать дополнительный раздел или скрыть описание под спойлер.
- Пояснение функции/поля не должно дублировать информацию из других пояснений функций.
- Дополнительные параметры, требующие описания выделяются ковычками.
- Пример оформления полей.
- Заголовок спойлера должен отражать содержание и быть понятным для пользователя.
- Если же в разделе статьи есть информация технического характера или же информация, которая может пригодиться в ограниченном количестве ситуаций, то спрячьте ее под Обычный спойлер
Объем статьи/раздела/спойлера
- Основной принцип, которым должен руководствоваться автор - удобство чтения пользователя.
- Рядовой читатель устает от прочтения 6-10 тысяч слов, что ровняется 40-50 тысячам знаков видимого текста. Если основная статья значительно больше данных значений, то имеет смысл вынести часть информации в отдельную статью.
- Если же статья является началом большой темы и выступает "фундаментом" для дальнейших статей, то ее размер может быть и больше 10 тысяч слов.
- Обратите внимание, что статьи с трудночитаемой (научной) информацией должны быть значительно меньше статей с общими понятиями.
- Как текст не учитываются: вставки и разделы "Содержание", таблицы, изображения, галереи и подписи к ним, справочные разделы ("Примечания", "См. также", "Ссылки", "Литература" и аналогичные им, категории и служебные отметки (дата последнего изменения, лицензия и т. п.).
- Если нужно вынести из статьи раздел, который содержит большое количество информации, то следует вкратце описать информацию и сделать ссылку на новую статью. Так же допустимо оставить просто ссылку на новую статью, без краткого содержания, если из названия понятно содержание.
- Для выделения раздела в отдельную статью должны учитываться следующие критерии: достаточный размер раздела (не стоит создавать статью ради 500-1000 знаков), единство содержания (раздел должен в полной мере освещать одну тему), не должно быть разночтений, не должно быть сложностей с формулировкой названия, статья должна обладать самостоятельной значимостью. Если один из критериев не учитывается, то выделять раздел в отдельную статью не стоит.
- В статье, создаваемой из раздела должно быть написано введение, кратко описывающее информацию из "родительской статьи" и отсылающее к ней.
- Под спойлер прячется не меньше 15 и не больше 50 слов. Данное ограничение создано специально, чтобы не создавалось спойлеров для 1-2 слов, а так не было соблазна спрятать текст объемом, сравнимым с полноценным разделом/статьей.
Общие рекомендации:
| Видимый (чистый) текст | Что делать |
|---|---|
| > 100 000 знаков |
Если статья не подпадает под исключения, её следует разделить на две или более подстатей. |
| > 50 000 знаков | Вероятно, статью следует разделить (с другой стороны, иногда для более полного раскрытия темы может быть оправдано создание статьи большого объёма). |
| > 30 000 знаков | На данном этапе вопрос о разделении статьи пока не стоит, однако возможно, что это придётся сделать в будущем. |
| от 1000 до 30 000 знаков | Не требуется принятия каких-либо действий по изменению объёма статьи. |
| < 1000 знаков | Если объём статьи не меняется на протяжении месяцев, следует задуматься о возможности её объединения с наиболее близкой по теме статьёй, сделав из неё перенаправление. Кроме того, почему бы просто не постараться добавить в неё информацию? |
| < 150-300 знаков | Статьи менее 150-300 знаков обычно должны удаляться. |
Работа с изображениями
У каждого формата изображения свои предназначения, поэтому, прежде чем выбрать какой-либо формат, будь то .jpeg, .png, .gif, .bmp, прочтите общую информацию об этих форматах. Для простых изображений (с небольшим количеством деталей) лучше подходит .png, т.к. занимает меньше места. Так же стоит учитывать, что одно изображение может решать несколько информационных задач, поэтому подбирать нужно максимально информативное изображение, взглянув на которое пользователь смог бы понять логику из текста. Немало важным является аккуратность в создании изображения, не стоит загружать некачественно обработанные файлы или не несущие никакой информации.
- Прежде чем загружать изображение на сервер убедитесь, что нужного файла на нем нет. Поищите файл по названию (название может отражать назначение изображения), также, поищите статьи, в которых могло бы использоваться нужное изображение. Если вы обнаружили, что изображения нет, тогда подберите или создайте его, далее загрузите файл на сервер, а затем разместить в статье .
- Прежде чем выгружать изображение на сервер проверьте его содержимое, а именно: есть ли на изображении личные данные людей (если скриншот сделан в программе, то имейте в виду, что в тестовой версии есть реальные данные людей, размещение этих данных без их согласия является нарушением закона), реальные фотографии людей, данные существующих организаций и др.
- В Википедии есть статья посвященная изображениям.
Употребление слов в контексте
- Кнопка - нажать на кнопку.
- Таблица -
- Контекстное меню - вызвать контекстное меню, использовать контекстное меню.
- Пункт (контекстного) меню - выбирается.
- Маркер - назначить маркер, перетащить маркер, настроить маркер, перенести маркер, снять назначение, переназначить.
- Доступ - предоставить доступ, запретить доступ, разрешить доступ, ограничить доступ.
- Фильтр - использовать фильтр, настроить фильтр, изменить фильтр.
- Настройка - применяется, выбирается, регулирует, назначает, изменяет.
- Галка - ставится, снимается.
- Окно - открывается, всплывает (для хинтов или необычных видео-эффектов всплывания), масштабируется, раскрывается (на весь экран), сворачивается (в трей).
- Интеграция - используется, отрабатывает, настраивается, работает.
- Двойной щелчок - действие пользователя, направленное на элемент программы. Фраза используется для замены сочетания "двойной клик".
- Сортировка - используется для описание действий с фильтром. Упорядочивание элементов списка.
- Группировка - разбитие элементов списка на группы. Используется для описание отчета. Пример сортировки и группировки находится на вкладке "Адреса". В таблице сверху можно сортировать заказы, а в нижней таблице группировать.
