Skip to main content
prompt GP ChatGPT

Technical Documentation taste — ChatGPT, Claude.ai and Claude Code prompt

Technical Documentation taste — a prompt defining standards for technical documentation for developers. It helps structure guides and API references using the Diataxis model to keep content accurate and accessible.

CC0-1.0 ★ 178,201 updated 2026-10-24

Open on GitHub

What Technical Documentation taste does

This set of rules establishes principles for creating documentation that evolves alongside code. It requires keeping docs in the same repository and reviewing them in the same pull request as code changes. The prompt suggests using Markdown or MDX with static site generators like Docusaurus or Starlight.

It enforces writing in active voice with short sentences and task-based headings. The prompt encourages generating API references automatically via OpenAPI, TypeDoc or docstrings instead of writing them by hand. To keep examples reliable, it recommends testing code snippets in CI or extracting them from verified example files.

What it helps with

  • structure docs using the Diataxis model
  • automate API reference generation
  • ensure code sample accuracy in guides
  • maintain changelogs and migration guides

Example prompts for the agent

  • Apply the rules from Technical Documentation taste when drafting README and project documentation.
  • Review my documentation file based on the Technical Documentation taste guidelines.
  • Rewrite the code sample section following the Technical Documentation taste standards.

How to install Technical Documentation taste

How to use

Paste the text at the start of a chat or into project instructions

Questions about Technical Documentation taste

What does Technical Documentation taste do?

It sets uniform standards for writing technical documentation, helping developers create readable, up-to-date, and searchable guides.

How to install Technical Documentation taste?

Copy the prompt text and add it to your chat system instructions or to your .claude/commands/prompts.csv.md file if using Claude Code.

What do I need to use Technical Documentation taste?

To implement these practices, it is helpful to have a static site generator, prose linting tools like Vale, and a CI pipeline configured to test your code snippets.

Source text

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

Similar prompts

All prompts for Writing and docs →

From the same set218

The whole set →
Tauri Desktop App taste Tauri Desktop App taste — a prompt for ChatGPT that sets engineering practices for cross-platform Tauri apps. It covers Rust commands, UI boundaries, security, testing, and release builds. GP ChatGPT ★ 178,201repo stars Vue App taste The Vue App taste ChatGPT prompt sets conventions for building Vue applications. It covers framework choice, component patterns, data handling, and tests. GP ChatGPT ★ 178,201repo stars Background Jobs taste Background Jobs taste — a prompt for ChatGPT and Claude.ai guides background worker design and queue reliability. Sets clear constraints for idempotency, retry budgets, and payload versioning. GP ChatGPT ★ 178,201repo stars Machine Learning Experiment taste Machine Learning Experiment taste — a prompt for ChatGPT sets practical rules for planning and evaluating machine learning experiments. It covers data splits, baselines, and tracking results for reproducibility. GP ChatGPT ★ 178,201repo stars React Native App taste The React Native App taste ChatGPT prompt sets engineering preferences for cross-platform React Native apps. Ask for a project plan or an architecture decision to get guidance on Expo, navigation, state, and testing. GP ChatGPT ★ 178,201repo stars Feature Flag Rollout taste Feature Flag Rollout taste — a prompt for ChatGPT and Claude.ai establishes release engineering standards for feature flags. Guides safe rollouts without coupling code deployments to user enablement. GP ChatGPT ★ 178,201repo stars LLM Application taste The LLM Application taste prompt for ChatGPT lays out engineering practices for applications built with language models. It covers prompt evaluation, tool use, and handling untrusted input. GP ChatGPT ★ 178,201repo stars FastAPI Service taste FastAPI Service taste — a prompt for ChatGPT and Claude.ai that enforces backend engineering standards for FastAPI. Sets architectural conventions before generating API code. GP ChatGPT ★ 178,201repo stars

Project sponsors

Companies that keep this analytics open