Начать

Правила оформления мануалов

Соблюдение этих правил поможет создавать качественные и понятные инструкции для всех пользователей.

1. Общие требования

1.1. Структура мануала

Каждый мануал должен содержать следующие разделы:

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

1.2. Форматирование

  • Используйте чёткие и краткие заголовки шагов.
  • Описания шагов должны быть детальными, но без воды.
  • Указывайте точные параметры: моменты затяжки, зазоры, допуски.
  • Выделяйте важные предупреждения и советы.

1.3. Категоризация

Правильно выбирайте категорию для мануала:

  • Двигатель;
  • Привод;
  • Рулевое управление;
  • Подвеска;
  • Электроника;
  • Колёса/Шины;
  • Тормозная система;
  • Топливная система;
  • Система охлаждения.

2. Содержательные требования

2.1. Точность

  • Указывайте точные технические параметры.
  • Используйте официальную терминологию.
  • При необходимости ссылайтесь на документацию.

2.2. Язык и стиль

  • Пишите ясно и лаконично.
  • Избегайте сложных конструкций.
  • Используйте профессиональную терминологию.
  • Пишите от третьего лица.

2.3. Безопасность

  • Выделяйте меры предосторожности.
  • Указывайте средства защиты.
  • Предупреждайте об опасных операциях.

2.4. Медиа-контент

  • Добавляйте схемы и иллюстрации.
  • Используйте формат WEBP или JPEG.
  • Максимальный размер — 2 МБ.
  • Подписывайте изображения.

3. Шаблон мануала

# [Название процедуры]

## Описание
[Краткое описание процедуры: цель, результат, для каких моделей]

## Необходимые материалы
- [Список запчастей]
- [Расходные материалы]
- [Инструменты]

## Пошаговая инструкция

### Шаг 1: [Название шага]
[Подробное описание действия]

### Шаг 2: [Название шага]
[Подробное описание действия]

## Полезный совет
- [Советы по выполнению]
- [Частые ошибки]

## Техника безопасности
⚠️ [Важные предупреждения]
🛡️ [Средства защиты]

4. Пример оформления

Замена масла в двигателе (Легко)

Описание:
Регламентная процедура замены моторного масла и масляного фильтра для двигателей объемом от 500 до 1000 см³.

Необходимые материалы:

  • Моторное масло (10W-40, API SN) — 3.5 литра;
  • Масляный фильтр — оригинальный или аналог;
  • Медная шайба сливной пробки;
  • Ключ для сливной пробки (на 17);
  • Съемник масляного фильтра.

Пошаговая инструкция:

Шаг 1. Прогрев двигателя
Запустите двигатель и дайте ему поработать на холостых оборотах 5-7 минут до рабочей температуры (около 90°C). Прогретое масло имеет меньшую вязкость и лучше сливается.

Шаг 2. Слив старого масла
Установите мотоцикл на центральную подставку. Подставьте емкость под сливную пробку. Открутите пробку и дайте маслу стечь (минимум 15 минут).

Шаг 3. Замена масляного фильтра
Используйте съемник для откручивания старого фильтра. Смажьте новое уплотнительное кольцо свежим маслом. Установите новый фильтр рукой.

Техника безопасности:

⚠️ Работайте с горячим маслом осторожно — используйте термостойкие перчатки.
🛡️ Используйте защитные очки.
🔥 Утилизируйте отработанное масло в специальных пунктах приема.