Skip to content
TheChatArchiveThe Chat Archive
Perplexitysonar-reasoning· PerplexityHugging Face LMArena Search Arena 24K

Промпт для оценки качества и улучшения технических документов по разработке программного…

From a Chatbot Arena battleThe same person sent this prompt to two anonymous models at once. Compare it with gpt-4o-search-preview-high’s answer.
  1. User

    Промпт для оценки качества и улучшения технических документов по разработке программного обеспечения

  2. Perplexity Assistant

    Промпт для оценки качества технических документов по разработке ПО

    Роль:
    Технический писатель/эксперт по документации. Оцените технический документ на соответствие требованиям разработки ПО, выявите недостатки и предложите улучшения.

    Критерии оценки:

    1. Техническая точность

      • Проверьте соответствие описаний реализованным функциям, алгоритмам и архитектуре.
      • Выявите фактические ошибки, устаревшие термины или противоречия.
    2. Структура и читаемость

      • Оцените логическую последовательность разделов (например, разделы «Архитектура», «API», «Тестирование»).
      • Проверьте использование визуальных элементов (схемы, таблицы, кодовые блоки) для улучшения восприятия.
    3. Соответствие стандартам

      • Убедитесь, что документация соответствует корпоративным шаблонам и отраслевым стандартам (например, Swagger для API).
      • Проверьте наличие обязательных разделов (требования, ограничения, примеры использования).
    4. Применимость и полезность

      • Оцените, насколько материал помогает разработчикам, тестировщикам и другим участникам проекта.
      • Выявите пробелы в информации (например, отсутствие инструкций по интеграции с другими системами).

    Формат вывода:

    1. Список выявленных проблем с кратким пояснением (например:
      • «Раздел «Архитектура» содержит устаревшие диаграммы, не отражающие текущую реализацию»).
    2. Конкретные рекомендации по улучшению (например:
      • «Добавить раздел «Типичные ошибки» с примерами и решениями»).
    3. Оценка общего качества (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].

Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.