Разработать Структуру Документации Api
Этот промпт предназначен для помощи техническим писателям, разработчикам программного обеспечения и командам API в создании структурированной и полной документации для API. Он направляет пользователя на определение всех ключевых компонентов документации, включая конечные точки (endpoints), форматы запросов и ответов, методы аутентификации, обработку ошибок, практические примеры и стратегию версионирования. Использование этого промпта позволяет создавать документацию, которая является последовательной, понятной и удобной для восприятия, повышая продуктивность разработчиков и снижая количество запросов в службу поддержки. Он подходит для REST, GraphQL и других архитектур API и может служить основой для автоматизированных инструментов документации, порталов для разработчиков или внутренних баз знаний. Кроме того, он облегчает командное взаимодействие, ускоряет процесс создания документации и обеспечивает высокий уровень качества. В результате получается профессиональный, организованный и доступный документ, который поддерживает масштабируемость и удобство сопровождения API, оптимизированный как для внутренних, так и для внешних разработчиков.
Промпт ИИ
Как использовать
1. Замените \[Название проекта/API] на название вашего API.
2. Настройте \[целевую аудиторию] в соответствии с пользователями документации.
3. Выполните промпт в любой модели ИИ для генерации полной структуры документации.
4. Проверьте результат на точность и полноту технической информации.
5. Используйте заголовки, таблицы и блоки кода для повышения читаемости.
6. Настройте примеры и инструкции по реальным сценариям использования.
7. Избегайте общих описаний, выделяйте уникальные функции и ограничения API.
Случаи использования
Создание структурированной документации API для внутренних команд
Стандартизация документации API в разных продуктах
Облегчение адаптации внешних разработчиков и партнеров
Основа для инструментов автоматизированной документации
Документирование REST, GraphQL или SOAP API
Предоставление примеров и пошаговых инструкций для разработчиков
Обеспечение ясности версионирования и обработки ошибок
Снижение количества запросов в поддержку благодаря полной документации
Профессиональные советы
Включайте реальные JSON payload и примеры
Настройте структуру под уровень знаний целевой аудитории
Используйте одинаковую терминологию во всех разделах
Подчёркивайте сложные или уникальные функции API
Используйте таблицы и блоки кода для лучшей читаемости
Регулярно обновляйте структуру документации с изменениями API
Проверяйте полноту и практическую применимость документации
Связанные промпты
Разработка Стратегии Технического Контента
Этот промпт предназначен для профессионалов, менеджеров по контенту и технических писателей, которым необходимо создать комплексную и применимую стратегию технического контента. …
Действуйте как стратег технического контента. Разработайте подробную стратегию технического контента для \[Название компании/продукта/проекта]. Стратегия должна …
Разработка Создания Базы Знаний
Этот промпт предназначен для помощи профессионалам, техническим писателям и менеджерам по знаниям в создании комплексных и структурированных баз знаний для …
Действуйте как эксперт по техническому письму и управлению знаниями. Создайте комплексную базу знаний для \[Тема/Организация/Продукт]. …
Больше от Техническое Письмо
Создание Стратегии Технической Документации
Этот промпт помогает профессионалам разработать комплексную стратегию технической документации, адаптированную под их организацию, продукт или проект. Он предназначен для технических …
Разработайте детализированную стратегию технической документации для \[название проекта/продукта]. Включите следующие разделы: 1. Анализ аудитории: определите …
Guia De Design E Redação De Manuais De Usuário
Este prompt avançado foi desenvolvido para redatores técnicos, gerentes de produto, engenheiros e equipes de suporte que desejam criar manuais …
Crie um manual de usuário completo, estruturado e profissional para \[Nome do Produto, Software ou …
Создание Плана Документации Программного Обеспечения
Этот промпт предназначен для помощи профессионалам в создании комплексного плана документации программного обеспечения, особенно для команд разработчиков, менеджеров продуктов и …
Создайте детальный план документации программного обеспечения для проекта \[Название проекта или ПО]. План должен включать: …
Создание Рамочной Структуры Процессной Документации
Данный промпт предназначен для специалистов, которые занимаются стандартизацией и документированием бизнес-процессов в организациях. Он помогает выстроить системный подход к описанию …
Выступи в роли профессионального технического писателя и на основе следующих данных создай подробную Рамочную структуру …
Стратегия Разработки Инструкции По Эксплуатации
Этот промпт предназначен для профессионалов, технических писателей и специалистов по обучению, которым необходимо разработать комплексную стратегию создания эффективных инструкций по …
Разработайте комплексную стратегию создания инструкции по эксплуатации для \[продукта/процесса/системы]. Стратегия должна включать: 1. Анализ целевой …
Разработка Стратегии Технического Контента
Этот промпт предназначен для профессионалов, менеджеров по контенту и технических писателей, которым необходимо создать комплексную и применимую стратегию технического контента. …
Действуйте как стратег технического контента. Разработайте подробную стратегию технического контента для \[Название компании/продукта/проекта]. Стратегия должна …
Разработка Создания Базы Знаний
Этот промпт предназначен для помощи профессионалам, техническим писателям и менеджерам по знаниям в создании комплексных и структурированных баз знаний для …
Действуйте как эксперт по техническому письму и управлению знаниями. Создайте комплексную базу знаний для \[Тема/Организация/Продукт]. …
Создание Технических Блогов
Этот промпт предназначен для профессионалов, технических писателей и создателей контента, которые хотят создавать высококачественные, точные и увлекательные технические статьи для …
Напишите подробную техническую статью для блога на тему \[ТЕМА], предназначенную для \[ЦЕЛЕВАЯ АУДИТОРИЯ]. Статья должна …