wiki-page-writer
Генерация технической документации с диаграммами Mermaid
Создание комплексной технической документации требует значительного времени и согласованного форматирования. Этот навык автоматизирует генерацию wiki-страниц с обоснованными цитатами, тёмными диаграммами Mermaid и структурой, совместимой с VitePress, для Claude, Codex и Claude Code.
Скачать ZIP навыка
Загрузить в Claude
Перейдите в Settings → Capabilities → Skills → Upload skill
Включите и начните использовать
Протестировать
Использование «wiki-page-writer». Документируйте middleware аутентификации в src/middleware/auth.ts
Ожидаемый результат:
- Сгенерированная страница документации с:
- - Обзором, объясняющим поток аутентификации и модель безопасности
- - Диаграммой последовательности, показывающей жизненный цикл аутентификации запроса
- - Таблицей компонентов, перечисляющей функции middleware с описаниями
- - Цитированием кода: (src/middleware/auth.ts:45), (src/utils/jwt.ts:22), (src/config/auth.ts:8)
Использование «wiki-page-writer». Создайте документацию для пайплайна данных в src/pipeline/
Ожидаемый результат:
- Сгенерированная страница документации с:
- - Диаграммой архитектуры, показывающей поток данных через этапы пайплайна
- - Диаграммой классов иерархии процессоров и интерфейсов
- - Деталями реализации с примерами псевдокода
- - Цитатами из 7 исходных файлов с конкретными номерами строк
Аудит безопасности
БезопасноStatic analyzer detected 34 patterns (external_commands, weak_crypto, reconnaissance) but all are FALSE POSITIVES. The skill contains only markdown documentation syntax with code blocks and YAML frontmatter examples. No executable code, network calls, or cryptographic operations exist. Safe for publication.
Оценка качества
Что вы можете построить
Документирование архитектуры CI/CD пайплайна
Генерация комплексной документации для CI/CD пайплайна с диаграммами последовательности, показывающими этапы сборки, цитирование компонентов и визуализации потока развёртывания.
Создание документации функций для open source
Создание детальной документации функций для open source проектов с диаграммами архитектуры, справочными таблицами API и цитированием путей кода для участников сообщества.
Построение внутренней технической wiki
Генерация согласованных внутренних страниц документации для инженерных команд со стандартизированными диаграммами, обоснованными цитатами и структурой для поиска.
Попробуйте эти промпты
Создайте страницу документации для [component name] в [file path]. Включите обзор, диаграмму архитектуры и процитируйте как минимум 3 исходных файла с номерами строк.
Напишите комплексную документацию для функции [feature name]. Проанализируйте все файлы в [directory path], создайте 3+ диаграммы Mermaid (последовательности, классы и блок-схемы), отследите полный поток данных и процитируйте конкретные пути кода со ссылками file:line.
Сгенерируйте справочную документацию API для [module/service]. Включите таблицы эндпоинтов с параметрами и типами возвращаемых значений, примеры использования в блоках кода и диаграммы последовательности, показывающие потоки запросов. Цитируйте файлы реализации для каждого эндпоинта.
Создайте руководство по миграции от [old system] к [new system]. Включите диаграммы сравнения архитектуры, таблицы маппинга компонентов, изменения потоков данных и пошаговые процедуры миграции с цитированием кода из обеих систем.
Лучшие практики
- Всегда отслеживайте фактические пути кода перед документированием функциональности
- Используйте согласованные цвета тёмной темы в диаграммах Mermaid для визуальной когерентности
- Цитируйте конкретные пути к файлам и номера строк для каждого технического утверждения
Избегать
- Делать утверждения о функциональности без чтения фактического кода реализации
- Использовать синтаксис Mermaid, который ломает рендеринг тёмной темы или совместимость с VitePress
- Генерировать шаблонную документацию без обоснованных цитат из источников