Промпт для оценки качества и улучшения технических документов по разработке программного…
- User
Промпт для оценки качества и улучшения технических документов по разработке программного обеспечения
Assistant
Промпт для оценки качества технических документов по разработке ПО
Роль:
Технический писатель/эксперт по документации. Оцените технический документ на соответствие требованиям разработки ПО, выявите недостатки и предложите улучшения.Критерии оценки:
-
Техническая точность
- Проверьте соответствие описаний реализованным функциям, алгоритмам и архитектуре.
- Выявите фактические ошибки, устаревшие термины или противоречия.
-
Структура и читаемость
- Оцените логическую последовательность разделов (например, разделы «Архитектура», «API», «Тестирование»).
- Проверьте использование визуальных элементов (схемы, таблицы, кодовые блоки) для улучшения восприятия.
-
Соответствие стандартам
- Убедитесь, что документация соответствует корпоративным шаблонам и отраслевым стандартам (например, Swagger для API).
- Проверьте наличие обязательных разделов (требования, ограничения, примеры использования).
-
Применимость и полезность
- Оцените, насколько материал помогает разработчикам, тестировщикам и другим участникам проекта.
- Выявите пробелы в информации (например, отсутствие инструкций по интеграции с другими системами).
Формат вывода:
- Список выявленных проблем с кратким пояснением (например:
- «Раздел «Архитектура» содержит устаревшие диаграммы, не отражающие текущую реализацию»).
- Конкретные рекомендации по улучшению (например:
- «Добавить раздел «Типичные ошибки» с примерами и решениями»).
- Оценка общего качества (A-F) с обоснованием.
Пример запроса:
<role>Технический писатель</role> Оцените документацию для API-сервиса на соответствие требованиям разработки ПО. <doc> {{DOCUMENT}} </doc> Выведите: 1. Список проблем с краткими пояснениями 2. Конкретные рекомендации по улучшению 3. Общая оценка качества (A-F)Особенности для LLM:
- Используйте итеративный подход: после генерации ответа уточняйте детали (например, «Предоставьте примеры улучшенных разделов»)[4].
- Включайте контекст проекта (например, «Документация должна соответствовать требованиям Agile»)[1].
- Для сложных документов добавляйте шаблоны ответа (например, таблицы с критериями оценки)[2].
Пример структурированного ответа:
**1. Проблемы** - Устаревшие диаграммы в разделе «Архитектура» - Отсутствие примеров запросов в разделе «API» **2. Рекомендации** - Обновить диаграммы с использованием актуальных инструментов (например, Mermaid) - Добавить раздел «Примеры использования» с кодом **3. Оценка** B+ (хорошая базовая информация, но требует детализации и визуализации)Такой промпт позволяет систематически улучшать качество документации, адаптируя её к потребностям команды разработки[1][4].
-
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.