| name | write-user-scenario-doc |
| description | Пишет понятную пользовательскую статью на русском языке для Fumadocs по конкретному сценарию на основе репозитория и интерфейса продукта. |
Написание статьи по пользовательскому сценарию
Когда использовать
Используй этот skill, когда нужно:
- написать одну полноценную статью для пользователя
- описать конкретный сценарий или функцию
- подготовить markdown/mdx-текст для Fumadocs
- объяснить шаги простым и понятным русским языком
Цель
Создать статью, которая поможет пользователю быстро понять, что делает функция, как ей пользоваться и что делать, если что-то не работает.
Основные требования
- Пиши на русском языке.
- Пиши понятно для обычного пользователя.
- Не превращай статью в техническое описание.
- Используй реальные названия кнопок, полей, меню и экранов.
- Не выдумывай поведение, которого нет в продукте.
- Если есть ограничения, честно укажи их.
Как работать
- Найди в репозитории нужный экран, маршрут, форму, модальное окно или другой участок интерфейса, связанный со сценарием.
- Проверь реальные тексты интерфейса.
- Определи, что пользователь хочет сделать и в каком порядке.
- Собери все важные шаги.
- Проверь, есть ли ограничения, ошибки, пустые состояния, валидации или особые условия.
- Напиши статью так, чтобы пользователь мог пройти сценарий без знания внутреннего устройства продукта.
Рекомендуемая структура статьи
Обычно статья должна содержать:
1. Заголовок
Понятный и прикладной. Например:
- Как загрузить PDF на доску
- Как включить микрофон и камеру
- Как пригласить ученика
2. Короткое вступление
Коротко объясни, что это за функция и зачем она нужна.
3. До начала работы
Если нужно, укажи, что должно быть подготовлено заранее.
4. Пошаговая инструкция
Опиши действия по шагам в правильном порядке.
Используй точные названия элементов интерфейса.
5. Важные особенности и ограничения
Укажи всё, что реально может повлиять на пользователя.
6. Если что-то пошло не так
Дай короткие и практичные советы по типовым проблемам.
7. Связанные статьи
Если уместно, предложи смежные материалы.
Стиль
- Пиши ясно и спокойно.
- Предпочитай простые предложения.
- Не перегружай текст.
- Не объясняй очевидное слишком подробно.
- Не используй сложные технические формулировки без необходимости.
- Не делай текст сухим и бюрократическим.
Формат результата
Верни полноценную статью в markdown или mdx, совместимую с Fumadocs.
У статьи должны быть:
- frontmatter
- заголовок
- структурированный текст
- готовность к сохранению в репозиторий без дополнительной переработки
Особое правило
Если данных в репозитории недостаточно, не выдумывай недостающие шаги.
Вместо этого прямо укажи, что часть поведения требует уточнения.
