Кому нужен этот промт и как он работает?
Этот промт предназначен для технических писателей, инженеров и специалистов по документации, которые работают с Azure DevOps Wiki. Он помогает правильно форматировать содержимое в Markdown с учетом официальных рекомендаций Microsoft, что значительно упрощает создание и поддержание структурированной, читабельной документации в проектах.
Основная задача промта — принимать от пользователя данные и факты и преобразовывать их в правильно оформленный текст для Wiki, разделяя информацию на отдельные логичные части. Это устраняет ошибки форматирования, экономит время на выравнивании стилей и помогает соблюдать стандарты оформления, которые важны для командной работы и поддержки проектов.
Промт работает как ассистент, который обсуждает с вами задачи и не приступает к созданию контента до получения всех нужных данных, а затем последовательно формирует окончательный текст, учитывая особенности разметки Azure DevOps Wiki и лучшие практики из официальной документации.
Готовый промт для использования
|
1 |
Представь, что ты мой полезный, остроумный и увлекательный технический писатель для Wiki, специализирующийся на Azure Devops Wiki. Твоя задача — правильно форматировать контент для Azure Devops, используя официальную документацию https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops и другие релевантные источники. Я буду предоставлять тебе информацию и факты, которые необходимо включить в Azure Devops Wiki. Не создавай содержимое Wiki до тех пор, пока я не передам всю информацию. Разбивай все мои запросы на отдельные задачи. |
Как пользоваться промтом и на что обратить внимание
- Предоставляйте всю необходимую информацию по частям, чтобы промт мог структурировать ее правильно.
- Убедитесь, что данные, которые вы даёте, точны и актуальны – это повысит качество итогового содержимого.
- Промт ориентирован на Azure DevOps Wiki, поэтому результат будет оптимизирован под именно эту платформу.
- Не ожидайте генерации готовой статьи до полного ввода данных – это предусмотрено для лучшего контроля процесса.
- В случаях сложных технических тем стоит разбивать описание на несколько больших частей, чтобы избежать потери важной информации и ошибок форматирования.
- Обратите внимание, что в очень специфичных случаях форматирование Azure DevOps может требовать настроек, которые лучше проверить дополнительно в официальной документации.
Примеры использования промта
Пример 1. Создание документации для развертывания инфраструктуры.
|
1 |
Представь, что ты мой полезный, остроумный и увлекательный технический писатель для Wiki, специализирующийся на Azure Devops Wiki. Твоя задача — правильно форматировать контент для Azure Devops, используя официальную документацию и другие релевантные источники. Я дам тебе информацию о шагах и параметрах развертывания сети и сервисов. Не создавай содержимое Wiki, пока я не передам всю информацию. Разбивай мою информацию на задачи и помогай систематизировать её. |
Этот пример помогает описать процесс с конкретными техническими деталями и сделать документацию более удобной для команды.
Пример 2. Подготовка инструкции по работе с пайплайнами CI/CD.
|
1 |
Представь, что ты мой полезный и остроумный технический писатель для Wiki Azure Devops, который отлично форматирует инструкции в Markdown согласно официальной документации. Я дам тебе описание шагов построения и настройки пайплайна. Не создавай текст, пока не получишь все детали. Делай все части отдельными задачами, чтобы сохранить порядок и полноту информации. |
Такой подход позволяет создавать структурированные руководства, которые легко поддерживать и обновлять.
Пример вывода нейросети по этому промту
✅ Пример: В данном разделе представлен обзор основных возможностей Azure DevOps Wiki. Мы рассмотрим форматирование заголовков, списков и таблиц с примерами из официальной документации. Далее будут описаны рекомендации по использованию Markdown-элементов, что позволит создать читабельную и удобную документацию для вашего проекта. Данный материал предназначен для команд разработки и технических писателей, стремящихся к упорядоченности знаний и эффективному совместному редактированию.
Примечание: результат приблизительный и может отличаться.
Итог: зачем использовать этот промт?
Использование данного промта существенно облегчает процесс подготовки технической документации для Azure DevOps Wiki. Он помогает структурировать информацию, соблюдать стандарты оформления и экономить время, сводя к минимуму ошибки форматирования. Это повышает качество документации и облегчает командную работу.
Основное преимущество: быстрое и грамотное формирование правильно отформатированного контента для Azure DevOps Wiki.
