База знаний ORIDOC 1.4.0

Как писать, чтобы читали

Несколько правил, по которым сделана эта документация. Они простые, но именно из-за них её читают.

  • Обращайтесь к читателю на «вы» и пишите глаголами: «Нажмите», «Выберите», «Введите».
  • Одна мысль на предложение. Длинное предложение почти всегда делится на два.
  • Вместо «предназначен для отображения» пишите «показывает». Вместо «манипулятор типа мышь» пишите «мышь».
  • Порядок действий это нумерованный список, один шаг на пункт.
  • Набор кнопок или значков это таблица из двух столбцов: что это и что делает.
  • Заголовок формулируйте как задачу читателя: «Как создать шаблон», а не «Создание шаблона».
  • Скриншот вставляйте, когда без него непонятно. Пять похожих скриншотов подряд читатель пролистывает.