Initial commit
This commit is contained in:
@@ -0,0 +1,71 @@
|
||||
# Вклад в документацию
|
||||
|
||||
Этот файл содержит руководство по внесению изменений в документацию.
|
||||
|
||||
## Принципы написания документации
|
||||
|
||||
### Язык и стиль
|
||||
|
||||
- Пишите простым и понятным языком
|
||||
- Избегайте жаргона и сложных технических терминов без объяснения
|
||||
- Используйте активный залог
|
||||
- Обращайтесь к пользователю на "вы"
|
||||
- Поддерживайте единый стиль во всех документах
|
||||
|
||||
### Форматирование
|
||||
|
||||
- Используйте Markdown для форматирования
|
||||
- Заголовки должны быть иерархичными (H1 → H2 → H3)
|
||||
- Списки используйте для перечислений
|
||||
- Код и команды оформляйте в блоки кода
|
||||
- Ссылки делайте относительными внутри документации
|
||||
|
||||
### Примеры
|
||||
|
||||
- Приводите примеры конфигурации
|
||||
- Показывайте скриншоты для важных шагов
|
||||
- Добавляйте таблицы для сравнения опций
|
||||
|
||||
## Внесение изменений
|
||||
|
||||
### Исправление ошибок
|
||||
|
||||
Если вы нашли ошибку в документации:
|
||||
|
||||
1. Создайте ветку от `main`
|
||||
2. Внесите исправления
|
||||
3. Отправьте изменения на ревью
|
||||
|
||||
### Добавление нового раздела
|
||||
|
||||
Для добавления нового раздела:
|
||||
|
||||
1. Обсудите необходимость раздела в чате поддержки
|
||||
2. Создайте план раздела
|
||||
3. Напишите черновик
|
||||
4. Отправьте на ревью
|
||||
|
||||
### Обновление существующих разделов
|
||||
|
||||
При обновлении информации:
|
||||
|
||||
1. Проверьте актуальность информации
|
||||
2. Внесите изменения
|
||||
3. Обновите дату последнего изменения (если применимо)
|
||||
4. Отправьте на ревью
|
||||
|
||||
## Проверка документации
|
||||
|
||||
Перед отправкой изменений:
|
||||
|
||||
1. Проверьте орфографию и пунктуацию
|
||||
2. Убедитесь, что все ссылки работают
|
||||
3. Проверьте форматирование Markdown
|
||||
4. Убедитесь, что примеры кода корректны
|
||||
5. Проверьте согласованность с другими разделами
|
||||
|
||||
## Обратная связь
|
||||
|
||||
Если у вас есть предложения по улучшению документации:
|
||||
|
||||
...
|
||||
Reference in New Issue
Block a user