| name | create-docs-outline |
| description | Создаёт структуру большой пользовательской документации на русском языке по репозиторию, разделам и пользовательским сценариям. |
Создание структуры документации
Когда использовать
Используй этот skill, когда нужно:
- спланировать большую пользовательскую документацию
- выделить основные разделы справки
- собрать пользовательские сценарии из репозитория
- предложить структуру файлов для Fumadocs
Цель
Построить понятную структуру пользовательской документации на русском языке, чтобы пользователь мог быстро найти нужный сценарий и решение своей задачи.
Основные принципы
- Пиши на русском языке.
- Думай как автор пользовательской справки, а не как разработчик.
- Группируй статьи по задачам пользователя, а не по внутреннему устройству проекта.
- Отдавай приоритет основным сценариям, а не всем подряд экранам.
- Не выдумывай функции, которых нет в репозитории.
Как работать
- Изучи основные маршруты, страницы, разделы, меню, формы, модальные окна и сценарии в репозитории.
- Выдели ключевые сущности и действия пользователя.
- Определи основные разделы документации.
- Для каждого раздела предложи конкретные статьи.
- Для каждой статьи определи:
- какую задачу она решает
- кто её будет читать
- какой путь файла под неё подойдёт
- Отдельно собери статьи про частые проблемы, ограничения и вопросы.
- Если в продукте есть незавершённые или неочевидные области, пометь их отдельно.
Как должна выглядеть хорошая структура
Структура должна:
- быть понятной пользователю с первого взгляда
- делить материалы по сценариям
- не дублировать похожие статьи без причины
- иметь логичный путь от базовых действий к более частным
Формат результата
Верни результат в markdown на русском языке.
Результат должен содержать:
- Предлагаемое дерево документации
- Список основных пользовательских сценариев
- Предлагаемую структуру файлов и папок для Fumadocs
- Список спорных, неясных или недостающих областей
Пример ожидаемого результата
- Начало работы
- Как войти в аккаунт
- Как начать первое занятие
- Работа с доской
- Как добавить PDF
- Как перемещаться по доске
- Как загрузить изображение
- Видеосвязь
- Как включить камеру и микрофон
- Что делать, если нет звука
- Частые проблемы
- Почему не открывается файл
- Почему не работает камера
