Подробный гайдлайн для базы знаний с едиными стандартами документации, структурой статей и правилами оформления. В статье вы получите готовый AI-промт для создания корпоративного style guide, шаблоны структуры, требования к скриншотам, форматированию и обновлению материалов. Подходит для SaaS, ИИ-сервисов, блогов, техподдержки и внутренних порталов компании.
# КОНТЕКСТ:<br />
Ты выступаешь в роли архитектора стандартов документации для базы знаний компании. Сейчас база знаний выглядит хаотично: статьи написаны в разном стиле, структура меняется от страницы к странице, где-то есть скриншоты, а где-то нет, оформление не совпадает, а инструкции читаются как тексты разных авторов.</p>
<p>Из-за этого пользователи теряют доверие к документации, дольше ищут ответы и чаще обращаются в поддержку. Твоя задача — создать единый гайдлайн для базы знаний, который станет главным стандартом для всей команды.</p>
<p>Важно:<br />
— гайдлайн должен быть ориентирован на российскую аудиторию;<br />
— использовать русский язык;<br />
— учитывать российские реалии;<br />
— примеры интерфейсов, сервисов и сценариев должны быть понятны пользователям из России;<br />
— все правила должны быть практичными и применимыми;<br />
— стиль должен быть единым и легко поддерживаться командой.</p>
<p># РОЛЬ:<br />
Ты — бывший технический писатель и редактор документации с опытом более 10 лет. Ты создавал базы знаний для SaaS-сервисов, AI-платформ и IT-компаний с миллионами пользователей. Ты понимаешь, почему пользователи бросают статьи на середине, как влияет хаос в документации на доверие к продукту и какие стандарты реально работают в командах.</p>
<p># ЗАДАЧА:<br />
Создай подробный и понятный гайдлайн для базы знаний компании.</p>
<p>Документ должен включать:<br />
— единый стиль документации;<br />
— структуру статей;<br />
— стандарты оформления;<br />
— требования к скриншотам;<br />
— правила форматирования;<br />
— политику ссылок;<br />
— стандарты доступности;<br />
— правила обновления документации;<br />
— систему проверки материалов;<br />
— шаблоны статей;<br />
— протокол актуализации базы знаний.</p>
<p># ТРЕБОВАНИЯ:<br />
1. Каждое правило должно объяснять:<br />
— зачем оно нужно;<br />
— как влияет на пользователя;<br />
— как помогает навигации и доверию.</p>
<p>2. Для каждого важного правила добавляй:<br />
— правильный пример;<br />
— неправильный пример;<br />
— сравнение.</p>
<p>3. Не используй абстрактные советы:<br />
Плохо:<br />
— «пишите дружелюбно»<br />
— «делайте удобно»</p>
<p>Хорошо:<br />
— «используйте короткие предложения до 15–20 слов»<br />
— «в начале статьи размещайте блок “Что получится в итоге”»</p>
<p>4. Все стандарты должны быть:<br />
— измеримыми;<br />
— понятными;<br />
— едиными для всей команды.</p>
<p>5. Добавь:<br />
— правила именования статей;<br />
— правила оформления H1/H2/H3;<br />
— требования к изображениям;<br />
— правила оформления кода;<br />
— требования к AI-скриншотам;<br />
— стандарты для инструкций пошагового типа.</p>
<p>6. Отдельно опиши:<br />
— как оформлять статьи для ChatGPT;<br />
— Claude;<br />
— Gemini;<br />
— Midjourney;<br />
— Flux;<br />
— Stable Diffusion;<br />
— Nano Banana;<br />
— генераторов изображений.</p>
<p>7. Добавь стандарты:<br />
— SEO для Яндекса;<br />
— форматирования под WordPress;<br />
— readability;<br />
— внутренней перелинковки;<br />
— оформления FAQ;<br />
— блоков предупреждений;<br />
— таблиц;<br />
— callout-блоков.</p>
<p>8. Включи:<br />
— шаблон идеальной статьи;<br />
— шаблон инструкции;<br />
— шаблон AI-промта;<br />
— чеклист проверки статьи перед публикацией.</p>
<p>9. Добавь быстрый одностраничный cheat sheet для авторов.</p>
<p># ИНФОРМАЦИЯ О КОМПАНИИ:<br />
— Стиль бренда: дружелюбный, экспертный, понятный без сложного технического языка.<br />
— Целевая аудитория: новички, пользователи ИИ, SEO-специалисты, блогеры, владельцы сайтов.<br />
— Платформа базы знаний: WordPress.</p>
<p># ФОРМАТ ОТВЕТА:<br />
Сформируй документ со следующей структурой:</p>
<p>1. Голос бренда и tone of voice<br />
2. Структура статей<br />
3. Правила оформления<br />
4. Стандарты форматирования<br />
5. Правила использования скриншотов<br />
6. Язык и стиль<br />
7. SEO-стандарты для Яндекса<br />
8. WordPress-оформление<br />
9. Стандарты доступности<br />
10. Политика ссылок<br />
11. Проверка документации<br />
12. Протокол обновления базы знаний<br />
13. Шаблоны статей<br />
14. Чеклист перед публикацией<br />
15. Быстрый cheat sheet для авторов</p>
<p>Используй:<br />
— таблицы;<br />
— списки;<br />
— примеры;<br />
— готовые шаблоны;<br />
— понятные правила;<br />
— короткие абзацы.</p>
<p>Документ должен быть готов для передачи команде без дополнительной доработки.Платформа базы знаний
Указывайте конкретно:
- WordPress;
- Confluence;
- Notion;
- Zendesk;
- Битрикс24;
- HelpDesk-систему.
Это влияет на:
- формат блоков;
- таблицы;
- ограничения редактора;
- вставку кода;
- оформление изображений.
Как получить максимально качественный результат
Перед запуском промпта желательно подготовить:
- 5–10 текущих статей базы знаний;
- примеры плохого оформления;
- список типовых ошибок;
- описание аудитории;
- tone of voice компании;
- требования SEO;
- структуру категорий базы знаний.
Как использовать внутри команды
Рекомендуемый процесс:
- Сгенерировать базовый гайдлайн.
- Проверить его на 3–5 реальных статьях.
- Скорректировать спорные правила.
- Утвердить единый шаблон.
- Внедрить чек-лист редактора.
- Проводить ревизию раз в квартал.
Где такой промпт особенно полезен
- SaaS-сервисы;
- IT-компании;
- онлайн-школы;
- сервисы поддержки;
- CRM-системы;
- корпоративные порталы;
- базы знаний для клиентов;
- внутренние базы знаний сотрудников;
- AI-проекты и документация по нейросетям.