Документирование Zensical

Принципы написания документации

Язык и стиль

• Пиши простым и понятным языком
• Избегай просторечий и сложных технических терминов без объяснения
• Используй активный залог
• Обращайся к пользователю документации на "вы"
• Поддерживай единый стиль во всех документах
• Не злоупотребляй emoji

Примеры

• Приводи примеры конфигурации
• Показывай скриншоты для важных шагов
• Добавляй таблицы для сравнения опций