Поиск пробелов в документации
Описание промпта
Анализ кода на предмет недостающей документации, неясных контрактов и скрытых edge-кейсов с генерацией конкретных примеров docstring.
- Анализирует исходный код на предмет недостатков в документации и генерирует детальный отчет с рекомендациями и примерами docstring.
- Повышает читаемость кода, ускоряет онбординг новых разработчиков, снижает риск ошибок при использовании API.
- Разработчики, технические писатели, лиды команд, отвечающие за качество кодовой базы.
Укажите код, язык, стиль (например, Google, NumPy) и аудиторию. AI проанализирует код и вернет структурированный отчет с примерами кода для исправления.
Необходимо предоставить исходный код, язык программирования, предпочитаемый стиль документации и целевую аудиторию.
Markdown-отчет с таблицей покрытия, списком критических пробелов, примерами docstring и планом действий.
Используйте этот промпт для ревью кода перед мержем или для автоматизации процесса документирования в CI/CD пайплайнах.
Не может проверить работоспособность примеров кода. Не заменяет глубокое понимание бизнес-логики, если она не очевидна из кода.
CODE
CODE
Исходный код для анализа.
LANGUAGE
LANGUAGE
Язык программирования кода.
DOC_STYLE
DOC_STYLE
Стиль документации (JSDoc, Google, NumPy, Sphinx и др.).
AUDIENCE
AUDIENCE
Целевая аудитория документации.
CONTEXT
CONTEXT
Дополнительный контекст использования кода.
Промпт открыт для всех. Зарегистрируйтесь, чтобы копировать одним кликом, сохранять промпты, оценивать их и подписываться на авторов.
Текст промпта
ChatGPT / Claude / Llama
Войти для копирования
Выступи в роли технического специалиста по документации с 10+ летним опытом. Твоя задача — проанализировать предоставленный код и выявить пробелы в документации, которые затруднят поддержку, онбординг и использование API. Фокусируйся на том, «как» и «почему», а не на очевидном «что». Игнорируй самодокументируемый код.
Входные данные:
Код:
{{CODE}}
Язык: {{LANGUAGE}}
Стиль документации: {{DOC_STYLE}} (JSDoc/Google/NumPy/Sphinx и др.)
Аудитория: {{AUDIENCE}} (внутренняя команда/пользователи публичного API)
Контекст: {{CONTEXT}}
Требования к анализу:
1. Найди отсутствующие docstring, неясные контракты функций, недокументированные граничные случаи и области, где будущие разработчики столкнутся с трудностями.
2. Оцени покрытие документации по категориям (модуль, классы, публичные функции, параметры, типы, примеры, исключения).
3. Укажи критические пробелы с обоснованием их влияния на usability.
4. Предложи конкретный текст документации (docstring) для каждого критического пробела, включая описание аргументов, возвращаемых значений, исключений и примеров использования.
5. Отметь избыточную документацию (очевидные комментарии), которую следует удалить.
6. Проверь соответствие выбранному стилю документации.
Формат вывода:
1. Краткое резюме: оценка количества критических пробелов и рекомендуемых улучшений.
2. Таблица покрытия документации с приоритетами.
3. Детальный разбор критических пробелов: локация, суть проблемы, влияние, приоритет и предложенный код docstring.
4. Рекомендуемые дополнения (средний/низкий приоритет).
5. Список избыточной документации.
6. Проверка соответствия стилю.
7. Список задач (Must Fix, Should Fix, Nice to Have).
Ограничения:
- Не предлагай документировать очевидный код.
- Не рекомендуй избыточные inline-комментарии.
- Не игнорируй конвенции стиля документации.
- Не предлагай дублирование информации из аннотаций типов.
Пример ожидаемого результата для функции:
### Gap 1: [Function Name]
**Location**: `file.py:42`
**What's Missing**: Описание аргументов и возвращаемого значения.
**Why It Matters**: Пользователи не поймут, как использовать функцию.
**Suggested Documentation**:
```python
def function_name(param1: str) -> dict:
"""Краткое описание.
Args:
param1: Описание параметра.
Returns:
Описание возвращаемого словаря.
Example:
>>> result = function_name("input")
"""
```Поделитесь в социальных сетях
Комментарии
Войдите, чтобы комментировать.
Комментариев пока нет.