Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Про оформление конфигурационных переменных в документации: Про конфигурацию 

  1. Написать Заголовок (название) страницы.
  2. Составить структуру, как минимум, до второго уровня (если удаётся, то и до третьего), если нужно использовать готовый шаблон тут
  3. Добавить содержание через кнопку "+" (Вставить прочий контент) > Оглавление.
  4. Добавить иллюстрации в структуру для каждого понятия.
  5. Сделать подписи под иллюстрациями.
  6. Написать текст в соответствии со структурой, соблюдая правило двух предложений и подстраивая структуру под текст.
  7. Редактируем, переделываем.
  8. Отправляем результат специалисту по рассматриваемой теме на рецензирование (специалистом по рассматриваемой теме является лицо, которое в состоянии выявить неточности и неясности в описании).
  9. Снова редактируем работу на основе отзыва рецензента (рецензентов).
  10. Используем разные стили заголовков для автоматического формирования сожержания и для лучшего визуального восприятия текста смотри тут .
  11. Использовать локальные ссылки для внутреннего пространства документации.

...