К основному содержанию
промпт GP ChatGPT

Technical Documentation taste — промпт для ChatGPT

Промпт Technical Documentation taste для ChatGPT, Claude.ai и Claude Code задаёт стандарты технической документации. Помогает структурировать руководства и описание API по модели Diataxis для их актуальности и доступности.

CC0-1.0 ★ 178 201 обновлён 2026-10-24

Открыть на GitHub

Что делает Technical Documentation taste

Этот набор правил определяет принципы создания документации, которая развивается вместе с кодом. Промпт требует хранить тексты в одном репозитории с проектом и включать их в тот же запрос на слияние (PR), что и изменения кода. Рекомендуется использовать Markdown или MDX в сочетании со статическими генераторами сайтов типа Docusaurus или Starlight.

Инструкции предписывают использовать активный залог и краткие предложения, а также применять задачу-ориентированные заголовки. Промпт советует автоматизировать создание справочников API через OpenAPI, TypeDoc или docstrings, чтобы избежать ручного обновления. Для обеспечения точности примеров кода предлагается их тестирование в CI или извлечение из файлов с проверенными примерами.

Какие задачи решает

  • структурировать документацию по модели Diataxis
  • автоматизировать генерацию справочников API
  • поддерживать актуальность примеров кода в руководствах
  • вести ченджлог и миграционные гайды

Примеры запросов агенту

  • Используй правила из Technical Documentation taste при написании README и руководств для этого проекта.
  • Проверь мой файл документации на соответствие рекомендациям из Technical Documentation taste.
  • Перепиши раздел с примером кода по стандартам Technical Documentation taste.

Как установить Technical Documentation taste

Как использовать

Вставьте текст в начало диалога или в инструкции проекта

Вопросы о Technical Documentation taste

Что делает Technical Documentation taste?

Промпт устанавливает единые стандарты написания технической документации, помогая разработчикам создавать читаемые, актуальные и удобные для поиска руководства.

Как установить Technical Documentation taste?

Скопируйте текст промпта и добавьте его в системные инструкции чата или в файл .claude/commands/prompts.csv.md, если используете Claude Code.

Нужно ли что-то для работы Technical Documentation taste?

Для реализации предложенных практик желательно наличие статического генератора сайтов, инструментов для проверки линтинга прозы, таких как Vale, и настроенного CI для тестирования примеров кода.

Исходный текст

prompts.csv · CC0-1.0
# Technical Documentation taste of a developer-focused writer
- Keep docs in the same repository as the code and review them in the same pull request as the change. Confidence: 0.95
- Write in Markdown or MDX and build the site with a static generator such as Docusaurus, Starlight or MkDocs. Confidence: 0.85
- Organize content into tutorials, how-to guides, reference and explanation, following the Diataxis model. Confidence: 0.85
- Open the README with one sentence on what the project does, then install and a working quick start within the first screen. Confidence: 0.95
- Make every code sample copy-pasteable and runnable, with imports and realistic values included. Confidence: 0.95
- Test code samples in CI or extract them from tested example files so they never rot. Confidence: 0.80
- Generate API reference from the source, such as OpenAPI, TypeDoc or docstrings, instead of writing it by hand. Confidence: 0.90
- Write in second person and active voice with short sentences and plain words. Confidence: 0.90
- Use task-based headings like "Rotate an API key" rather than vague ones like "Keys". Confidence: 0.85
- State prerequisites and versions at the top of every guide. Confidence: 0.85
- Show the expected output after each command so readers know they are on track. Confidence: 0.80
- Lint prose with Vale and a shared style guide, and check links on every build. Confidence: 0.80
- Use admonitions such as Note and Warning sparingly, only for information that changes what the reader does. Confidence: 0.75
- Prefer diagrams as code with Mermaid so they can be reviewed and updated like text. Confidence: 0.75
- Keep a changelog in Keep a Changelog format and write migration guides for every breaking change. Confidence: 0.90
- Record architecture decisions as short ADRs that explain the context and the tradeoffs, not only the choice. Confidence: 0.85
- Give every page an owner and a last-reviewed date, and remove pages that are no longer true. Confidence: 0.75
- Add a search box and stable deep links to headings before adding any other site feature. Confidence: 0.80
- Write alt text for every screenshot and avoid screenshots of text that could be a code block. Confidence: 0.85
- Collect feedback with a simple "Was this page helpful?" widget and review the results monthly. Confidence: 0.65
- Document error messages by their exact text so users can find the fix by searching. Confidence: 0.85

© f · CC0-1.0 · f/prompts.chat

Похожие промпты

Все промпты по теме «Тексты и документация» →
documentation-writer официальный github Скилл documentation-writer для создания технической документации по фреймворку Diátaxis: туториалы, гайды, справки и объяснения. Предлагает структуру перед написанием. CX Codex +1 27 757установок technical-writing backnotprop Скилл technical-writing для Claude Code задаёт правила для документации, RFC, README и сообщений коммитов. Вызывается командой /technical-writing. CX Codex +1 10 700установок technical-writer curiositech Скилл technical-writer помогает оформлять документацию для разработчиков по методологии Diátaxis: API-справочники, ADR, ранбуки и README с проверенными примерами кода. CX Codex +1 221установок documentation-standards terrylica Скилл documentation-standards задаёт правила оформления Markdown для чтения моделями и экспорта в PDF через Pandoc. Спасает от поломанной нумерации глав и хаоса в структуре. CX Codex +1 161установок documentation-tools Legion Code Inc. Плагин documentation-tools автоматизирует аудит кодовой базы, сборку документации API и выгрузку отчётов в PDF, Word и Markdown. CX Codex ★ 96звёзд репо documentation mcollina Скилл documentation структурирует техническую документацию по фреймворку Diátaxis. Он помогает писать туториалы, инструкции how-to, справочники и концептуальные статьи без каши в структуре. CX Codex +1 2 000установок

Из того же набора218

Весь набор →
Tauri Desktop App taste Промпт Tauri Desktop App taste для ChatGPT с правилами разработки кроссплатформенных приложений на Tauri. Задаёт подход к Rust-командам, интерфейсу, безопасности и сборке. GP ChatGPT ★ 178 201звёзд репо Vue App taste Промпт Vue App taste для ChatGPT задаёт правила разработки приложений на Vue. Он помогает выбрать стек и договориться о структуре компонентов, работе с данными и тестах. GP ChatGPT ★ 178 201звёзд репо Background Jobs taste Промпт Background Jobs taste для ChatGPT и Claude.ai задаёт инженерные правила надёжности для фоновых задач и очередей. Помогает проектировать воркеры с защитой от дублей, взаимных блокировок и зависаний. GP ChatGPT ★ 178 201звёзд репо Machine Learning Experiment taste Промпт Machine Learning Experiment taste для ChatGPT задаёт практики подготовки и оценки ML-экспериментов. Он помогает спланировать проверку данных, выбрать baseline и сохранить результаты воспроизводимыми. GP ChatGPT ★ 178 201звёзд репо React Native App taste Промпт React Native App taste для ChatGPT задаёт инженерные предпочтения для кроссплатформенных приложений. Запросите план проекта или решение по архитектуре, чтобы получить рекомендации по Expo, навигации, состоянию и тестам. GP ChatGPT ★ 178 201звёзд репо Feature Flag Rollout taste Промпт Feature Flag Rollout taste для ChatGPT и Claude.ai формулирует правила и инженерные привычки по выкатке фиче-флагов. Задаёт чёткие критерии разделения деплоя и релиза новой функциональности. GP ChatGPT ★ 178 201звёзд репо LLM Application taste Промпт LLM Application taste для ChatGPT с принципами проектирования приложений на базе языковых моделей. Он помогает продумать оценку ответов, работу с инструментами и защиту данных. GP ChatGPT ★ 178 201звёзд репо FastAPI Service taste Промпт FastAPI Service taste для ChatGPT и Claude.ai задаёт инженерные правила проектирования бэкенда на FastAPI. Фиксирует архитектурные соглашения перед генерацией сервисов. GP ChatGPT ★ 178 201звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой