Optimize seven documentation discovery fields
By the end of the lesson, you will have:- one sentence stating the question the page owns;
- one stable folder and slug path written in audience language;
- a task-shaped title and matching H1;
- a useful search description;
- an answer-first opening of no more than a few short paragraphs;
- headings that still make sense when retrieved alone;
- a short editorial record showing what was verified;
- a 30-minute process you can repeat across an existing documentation site.
Keep documentation findability and usability aligned
A documentation page has two audience jobs:- A person or agent must be able to find and select the page.
- After selecting it, the person or agent must be able to use the answer successfully.
If someone selects this result, does the page actually deliver the outcome it names?If the answer is no, rewrite the body or narrow the promise. Do not use stronger metadata to disguise a weaker page.
Step 1: audit the documentation page contract
A useful documentation page has one address and nine content parts:
The owning URL and items 1–4 form the highest-priority editorial discovery surface. They are what
a search result, answer engine, browser tab, citation, or retrieved chunk can use when deciding what
the page is about.
Items 5–9 keep the promise after selection. They still matter: a discoverable page that cannot be
used is not successful. They are simply outside this focused lesson.
Audit the current documentation discovery fields
Open the page you are improving and copy these six fields into a blank note:Step 2: give the page one dominant question
A page may answer related subquestions, but it should have one dominant reason to exist. Complete this sentence:- the desired outcome;
- the audience or prerequisite knowledge;
- the product, framework, language, API version, or region;
- the correct procedure;
- the error diagnosis or recovery path;
- the choice the reader must make.
Turn a broad documentation topic into one owner question
The broader reference or hub can remain. The focused page owns the searchable task and links back to
the complete contract.
Step 3: choose a descriptive slug and folder structure
The full URL should explain where the answer belongs and what the page owns. Build the path from stable context to the specific job:- use lowercase words separated by hyphens;
- let every folder add stable context that helps identify the answer;
- write the leaf slug around the task, decision, exact error, or reference item;
- keep navigation order in the sidebar configuration, not in prefixes such as
01-orchapter-3-; - do not repeat a word when a parent folder already supplies the context;
- add version, language, framework, or region folders only when they change the answer;
- avoid dates, campaign names, team names, IDs, and UI labels that are likely to change;
- use query parameters only for real variants, then control duplication and canonical signals;
- add a permanent redirect whenever a published URL changes.
Bun uses folders to make a short leaf slug meaningful
Bun’s simple HTTP server guide uses:simple would be meaningless at the root. Inside /guides/http/, the full path identifies a
simple HTTP guide, while the title Write a simple HTTP server supplies the complete task. Use this
pattern when parent folders are stable, audience-facing concepts—not internal team boundaries.
Stripe keeps the stable payment task in the path
Stripe’s payment guide uses:payment-ui and platform. The reusable lesson is to keep the enduring question in the path and
treat interface choices as variants when they do not deserve separate owner pages. Because parameters
can create duplicate crawl paths, verify canonicals and inventory rules rather than copying the
implementation blindly.
MDN uses a deep taxonomy for exact reference retrieval
MDN’s HTTP 404 reference uses:Cloudflare separates educational questions from product reference
Cloudflare’s DNS explainer uses:/learning/ folder tells the reader to expect category education rather than configuration or
API reference. The /dns/ folder groups related questions, and the leaf matches the beginner’s
question. Use a purpose folder when it communicates a real audience intent; do not create one merely
because the content team has that name.
Rewrite numbered course URLs around the page job
This course previously stored lesson order in the URL. The navigation configuration already owns that job, so the numbers added no retrieval value:
The old paths should permanently redirect to the new owner pages. Renaming without redirects trades a
cleaner slug for broken links and split identity.
Audit the proposed documentation URL
Read the full path without the title or sidebar:Step 4: write the title before the body
The title is a content decision, not final polish. It forces you to state which question the page owns. Use one of these patterns:Rewrite generic documentation titles around the task
Avoid titles such as
Overview, Getting Started, Method 3, Authentication, Forms, and More Information. They can work as sidebar labels, but they do not express a complete question in a
search result, citation, browser history, or retrieved chunk.
The new title is approved only when the body delivers the promise. A credential page does not become
a complete integration guide merely because its title says “Send a message.”
Combine audience language with exact product terminology
Lead with the language someone knows before learning the product term, then introduce the exact term needed to use the product. Instead of choosing between “get rows from a table” and Airtable’sList records, write:
Retrieve and paginate rows from an Airtable table with the List records operation.
This lets the page match the task while teaching the product vocabulary.
Test three candidate documentation titles
Write three possible titles for your page. Reject any title that:- could describe several pages on the same site;
- promises an outcome the body does not complete;
- depends on the sidebar for product context;
- leads with an internal label an unfamiliar reader would not use.
Step 5: write a useful description
The description should help someone decide whether this is the right page. Write it by hand after the title. A useful description:- states what the reader will accomplish;
- uses concrete product, action, and qualifier nouns;
- distinguishes the page from neighboring pages;
- often fits in roughly 140–160 characters without treating length as a ranking rule;
- avoids marketing adjectives and generic invitations;
- describes content that already exists on the page.
Airtable is a low-code platform for building collaborative apps.Useful:
Retrieve records from an Airtable table, filter and sort the result, select fields, and follow offset pagination beyond the first 100 rows.The weak description describes the company. The useful one describes the job, supported variations, and important pagination boundary.
Rewrite descriptions around the page outcome
Do not automatically copy the first paragraph into the description. The opening and description have
different jobs and should not repeat the same sentence.
Step 6: make the first 200 words route the reader
The opening should answer four questions quickly:- What should the reader do or choose?
- When does this answer apply?
- What product term, interface, or version do they need to know?
- What result will show success?
Before: an opening that describes the company instead of the task
Airtable is a low-code platform for building collaborative apps. Our powerful platform helps teams organize their most important work.This could introduce almost any Airtable page. It does not route a developer to the
List records
operation.
After: an opening that routes to the Airtable operation
Step 7: use headings as retrieval keys
A search engine or agent may surface one section without the page title. Make each H2 understandable on its own. Weak headings:SetupUsageExampleErrorsOption 2
Create a Typeform personal access tokenCombine Calendly schedules and busy timesPage through more than 100 Airtable recordsUpload files larger than 150 MiB with a Dropbox sessionSend the Intercom-Version header
Rewrite generic documentation headings as retrieval keys
Use a logical hierarchy and do not skip heading levels for visual styling. Keep response tabs, status
codes, and component labels out of the article H1 outline.
Test the H1 and H2 map without the body copy
Copy only the H1 and H2 headings into a note. A reviewer should be able to tell:- what the page helps them do;
- the major steps or decisions;
- which product or interface applies;
- where limits and recovery appear.
Overview → Setup → Usage → Example → Errors, rewrite it before polishing
the body.
Step 8: use a discovery-first editorial workflow
The workflow prevents a strong-looking title from drifting away from product truth.Write a one-page documentation discovery brief
Draft the URL and five editorial discovery fields together
Write the URL, title, description, H1, first 200 words, and H2 outline in one pass. Read them without the sidebar or surrounding site.Run the documentation promise test
Hide the proposed title and give the remaining page to a reviewer:Can this page deliver the task named by the proposed title?If it only supplies a prerequisite or sends the reader elsewhere, narrow the title or plan a body rewrite.
Verify the product facts behind the page promise
The product or subject-matter owner checks terminology, version, endpoint, permissions, limits, regions, results, errors, and current-versus-deprecated behavior. Mark unresolved facts withVERIFY;
do not smooth uncertainty into authoritative copy.
Test every documentation representation in isolation
Review only:- the title;
- the canonical URL;
- the description;
- the first 200 words;
- the H1 and H2 list;
- the
llms.txtlink description, when present; - the generated Markdown.
Publish the documentation page with an owner and review date
Record the responsible product owner, independent reviewer, and last-reviewed date for pages that are high-risk or change quickly. UpdatedateModified only after material review, not on every build.
Step 9: run a 30-minute documentation improvement pass
Use this pass when a full rewrite is not yet possible.Minutes 0–5: name the documentation question and owner URL
- Write the one-sentence dominant question.
- Confirm the current URL should own it.
- If the URL changes, record the permanent redirect before publishing.
- Mark missing question evidence as
RESEARCH PLACEHOLDER.
Minutes 5–10: fix the documentation search result
- Rewrite the title around the real task.
- Hand-write a description that distinguishes this page.
- Confirm neither field overpromises the body.
Minutes 10–15: fix the first 200 words
- Put the direct answer first.
- Name the product mechanism, scope, and expected result.
- Remove slogans, history, and navigation instructions before the answer.
Minutes 15–20: fix the documentation heading map
- Rewrite vague H2s as tasks, questions, decisions, or symptoms.
- Run the heading-only test.
- Keep one article H1.
Minutes 20–25: verify the page promise and product facts
- Check product terms, versions, limits, and claims.
- Add
VERIFYto unresolved facts. - Confirm the body delivers the title’s outcome.
Minutes 25–30: inspect HTML, Markdown, metadata, and machine indexes
- Preview the search title and description.
- Read the initial HTML and generated Markdown.
- Check the
llms.txtdescription when present. - Confirm the title, H1, opening, and headings describe one job.
Audit one documentation page after optimization
Complete this review sheet for one page:Worked Airtable documentation discovery audit
This example uses the public AirtableList records material reviewed on 8 August 2026. Recheck the
live contract before using it as current product guidance.