documentation
Пишите лучшую документацию
Auch verfügbar von: Joseph OBrien,Joseph OBrien,sickn33,CrazySwami,DaoThiHuong2111
Документация часто оказывается неструктурированной и трудной для чтения. Этот навык предоставляет четкие рекомендации по созданию хорошо организованных файлов markdown с правильной структурой, форматированием и визуальной иерархией.
Die Skill-ZIP herunterladen
In Claude hochladen
Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen
Einschalten und loslegen
Teste es
Verwendung von "documentation". Напишите руководство по началу работы для моего Python-проекта
Erwartetes Ergebnis:
- • Создает getting-started.md с заголовками для предварительных требований, установки, быстрого старта и примеров
- • Использует блоки кода для команд и фрагментов конфигурации
- • Добавляет маркированные пункты для быстрых справочных шагов
- • Записывает непосредственно в файл и сообщает местоположение
Verwendung von "documentation". Создайте предложение проекта для новой функции
Erwartetes Ergebnis:
- • Генерирует proposal.md с формулировкой проблемы, решением, временной шкалой и результатами
- • Использует четкие разделы с заголовками для удобной навигации
- • Сохраняет убедительный, но честный тон, подходящий для предложений
- • Сохраняет в папку proposals с описательным именованием
Verwendung von "documentation". Документируйте конечные точки API для моего REST-сервиса
Erwartetes Ergebnis:
- • Создает api.md с разделами для каждой конечной точки
- • Использует таблицы для форматов запросов/ответов
- • Включает примеры кода для каждой операции
- • Организует по типам ресурсов для логической структуры
Sicherheitsaudit
SicherPure prompt-based skill containing only documentation guidelines. No code execution, no file access beyond standard AI capabilities, no network calls, and no external commands. Static findings are false positives - the analyzer misidentified documentation-related text as cryptographic references and markdown backticks as shell execution. This is a set of best practices for writing documentation.
Risikofaktoren
🌐 Netzwerkzugriff (1)
⚙️ Externe Befehle (2)
Qualitätsbewertung
Was du bauen kannst
Создание технической документации
Пишите четкие README, API-документацию и технические руководства с правильной структурой
Создание планов проектов
Создавайте действенные планы и предложения с конкретными шагами и логичной структурой
Структурирование длинного контента
Организуйте заметки мозгового штурма, руководства и спецификации с заголовками и визуальной иерархией
Probiere diese Prompts
Напишите README для моего проекта в PROJECT/README.md. Включите разделы для обзора, установки, использования и участия в разработке.
Создайте API-документацию в docs/api.md. Документируйте основные конечные точки, форматы запросов/ответов и аутентификацию.
Напишите предложение проекта в proposals/feature-x.md. Включите формулировку проблемы, предлагаемое решение, временную шкалу и ожидаемые результаты.
Создайте документацию архитектуры в docs/architecture.md. Включите обзор системы, диаграмму компонентов, поток данных и принятые решения по дизайну.
Bewährte Verfahren
- Всегда записывайте в файл вместо вывода контента в терминал
- Используйте заголовки для создания четкой структуры и навигации
- Разбивайте текст списками, таблицами и блоками кода для улучшения читаемости
Vermeiden
- Вывод длинного контента непосредственно в терминал без записи в файл
- Игнорирование назначения документа при выборе тона и структуры
- Использование сплошного текста без форматирования или визуальной иерархии