For the complete documentation index, see llms.txt. This page is also available as Markdown.

Prompt Patterns

Request skeletons for common documentation jobs.

Recipes for common documentation jobs: each pattern is a request skeleton you can copy, adapt, and send from git or the app. The craft behind them is in Writing requests.

New page from scratch

When to use: a page that should exist and doesn't.

@doc.holiday, create a new file at /guides/webhook-setup.md

Write a how-to guide for setting up webhooks. Cover: creating the endpoint,
configuring the secret, and verifying delivery. The reader is an administrator
who has never used our webhooks. Explore the source to determine the actual
configuration fields and defaults; never assert a field you can't find.
End with a short "Verify it works" section.

Why it works: exact path, defined reader, bounded coverage, and an explicit explore-to-determine clause that trades completeness for accuracy.

Update after a change

When to use: something shipped; a page is now wrong.

@doc.holiday update /docs/authentication.md to cover the token-refresh flow
merged in PR #198. Keep the API-key section unchanged. Update the code
examples to match the current parameter names in the source.

Why it works: names the trigger (the PR), the file, and the boundary. The best time to send it is in a comment on that PR; the context comes free.

Release notes with a shape

When to use: you want release notes that read the way your team likes.

Why it works: range, grouping, altitude ("for customers"), and an exclusion rule are the four decisions release notes always need someone to make.

The fix batch

When to use: review found several precise errors on one page. Batch them into one request; cite each error's location, the wrong text, and the right text.

Why it works: "apply exactly / change nothing else" turns the writer into a surgeon. This is also the right way to correct Doc Holiday's own output: corrections through the same pipeline keep the page's history in one place.

Building a doc set

When to use: several related pages that belong together.

Ask for the whole set in one request; Doc Holiday can fulfill any number of pages in one piece of work. Include a short site map so every page lands at its exact path and cross-links to its siblings:

Why it works: the map fixes each page's path and role before writing starts, so the set arrives coherent, cross-linked, and reviewable as one piece of work. To review page by page instead, send one request per page and paste the same map into each; the shared map keeps the set coherent either way.

Placeholders that must survive

When to use: a human will insert something later (a screenshot, a metric, a date).

Why it works: without the "verbatim, do not attempt to determine" clause, a diligent writer will helpfully fill in the placeholder, with something plausible and wrong. Make non-negotiable tokens explicit.

The review pass

When to use: you want to know what's wrong with a page before anything moves.

Why it works: separating finding problems from fixing them gives you a reviewable list before anything moves, and pairs naturally with a fix batch as the follow-up.

Next

The two standing levers that make every one of these patterns land better: Writing style guides and Writing planning instructions.

Last updated

Was this helpful?