Write docs page skill

This guide covers using /write-docs-page, the recommended approach for creating new documentation pages in docco with consistent structure and navigation updates.

Before you start

Before you run the skill, decide what page type you need and where the page should live insideapp/docs/. The better your initial prompt, the fewer follow-up edits you need.

  • Choose a page type that matches your goal: tutorial, concept, component reference, guide, API reference, or feature overview.
  • Decide the target route, for example /docs/guides/write-docs-page.
  • Prepare adjacent pages so the skill can update PageNav links in both directions.

Use the skill

1

Describe the page clearly

Start with the page objective, page type, section path, and required components. Include tone requirements like Australian English and any callouts you want.

2

Run /write-docs-page with concrete requirements

bash
/write-docs-page Create a guide page at app/docs/guides/authoring-workflows/page.tsx. Include DocBreadcrumb, TableOfContents, and PageNav. Add sections for prerequisites, workflow steps, and verification. Use Australian English.
3

Include navigation placement details

bash
/write-docs-page Register the page in lib/docs-config.ts under Guides. Place it between TypeScript and Configuration, and update adjacent PageNav links.
4

Apply and verify

Review the generated file, then check that metadata, heading IDs, TOC entries, and links all align.

Good to know

You get the best results when you specify the exact route, page type, and the previous and next page titles in your prompt.

Review generated output

After generation, run through this quick review pass before you keep the page:

  • Confirm export const metadata includes a concise title and description.
  • Ensure every h2 and h3 has an id and appears intocItems.
  • Verify DocBreadcrumb, TableOfContents, and PageNav follow the standard docs layout.
  • Check that links are descriptive and any external links include target andrel attributes.
  • Confirm spelling and terminology use Australian English consistently.

Common adjustments

If the first output is close but not perfect, run the skill again with a narrow correction prompt instead of regenerating the full page.

bash
/write-docs-page Update only the opening paragraph and tocItems for app/docs/guides/authoring-workflows/page.tsx. Keep all existing sections and PageNav links unchanged.

Avoid broad rewrite prompts

Broad prompts can replace working navigation and remove useful content. Ask for targeted edits when you only need small changes.

All done

You can now use /write-docs-page to create or refine documentation pages quickly while keeping the site structure consistent.