2.8 KiB
2.8 KiB
Вклад в документацию
Этот файл содержит руководство по внесению изменений в документацию.
Принципы написания документации
Язык и стиль
- Пишите простым и понятным языком
- Избегайте жаргона и сложных технических терминов без объяснения
- Используйте активный залог
- Обращайтесь к пользователю на "вы"
- Поддерживайте единый стиль во всех документах
Форматирование
- Используйте Markdown для форматирования
- Заголовки должны быть иерархичными (H1 → H2 → H3)
- Списки используйте для перечислений
- Код и команды оформляйте в блоки кода
- Ссылки делайте относительными внутри документации
Примеры
- Приводите примеры конфигурации
- Показывайте скриншоты для важных шагов
- Добавляйте таблицы для сравнения опций
Внесение изменений
Исправление ошибок
Если вы нашли ошибку в документации:
- Создайте ветку от
main - Внесите исправления
- Отправьте изменения на ревью
Добавление нового раздела
Для добавления нового раздела:
- Обсудите необходимость раздела в чате поддержки
- Создайте план раздела
- Напишите черновик
- Отправьте на ревью
Обновление существующих разделов
При обновлении информации:
- Проверьте актуальность информации
- Внесите изменения
- Обновите дату последнего изменения (если применимо)
- Отправьте на ревью
Проверка документации
Перед отправкой изменений:
- Проверьте орфографию и пунктуацию
- Убедитесь, что все ссылки работают
- Проверьте форматирование Markdown
- Убедитесь, что примеры кода корректны
- Проверьте согласованность с другими разделами
Обратная связь
Если у вас есть предложения по улучшению документации:
...