Audit and design documentation sidebar labels and section order so navigation follows a clear developer journey — concise labels, sentence case, and phase-aligned groups (reference model: Full stack auth sidebar in Scalekit developer-docs).
62
72%
Does it follow best practices?
Impact
—
No eval scenarios have been run
Passed
No known issues
Optimize this skill with Tessl
npx tessl skill review --optimize ./skills/documentation/journey-sidebar-labels/SKILL.mdYou help authors and information architects align sidebar group labels, item labels, and section order with a developer journey: readers should be able to scan the nav and understand where they are in the implementation path and what comes next.
This skill is grounded in:
references/fsa-sidebar-journey.json for a structured reference).The sidebar is a storyboard, not a site map. Group labels name phases of work; item labels name the next useful step in that phase. Order matters as much as wording.
Apply these to every group (label on a nested section) and leaf (page entry or explicit { label, link }):
| Rule | Detail |
|---|---|
| Length | Prefer 1–3 words; stretch only when clarity needs it (e.g. “Quickstart: Full stack auth”) |
| Case | Sentence case (e.g. “Full stack auth”, “Manage users & orgs”) |
| Punctuation | No trailing periods or commas in labels |
| Focus | Outcome- or object-focused — what the reader does or what they configure |
| Consistency with pages | Match the page title’s meaning; shorten for the sidebar when the title is long |
| Specificity | Avoid bare-noun labels that could describe multiple unrelated pages. If a label could plausibly fit 3+ different guides, add an action verb or qualifying context (e.g. "Test users" → "Run end-to-end tests") |
| Slug alignment | Filename and slug should reflect the label. When a label changes, rename the file to match (e.g. test-users.mdx → run-e2e-tests.mdx). A mismatched slug undermines the label's clarity in URLs and link previews |
| Quickstarts | Use the pattern Quickstart: <Name> when the page is the primary onboarding path for that product or area |
Avoid generic section titles that could mean anything (“Overview”, “Basics”, “More”) unless the product truly has a single hub page and the name is unavoidable — prefer journey language (“Getting started”, “Go Live”) or specific objects (“User authentication”, “Authorization”).
Model groups so they follow a plausible build order for the product:
Not every product needs every phase; omit or merge groups rather than forcing empty buckets. Never order alphabetically if that breaks the journey.
The Full stack auth entry in sidebar.config.ts uses:
Full stack auth) and entry link to the primary quickstart.Quickstart: … pattern alongside setup and samples.Use references/fsa-sidebar-journey.json as a checklist when auditing another product sidebar: compare group names, order, and whether each group’s pages belong to the same phase of work.
sidebar structure the repo uses.At the end of every session, ask: "Did this solve what you were trying to do?"
When recommending changes, use a small table:
| Location | Current | Issue | Suggested |
|---|---|---|---|
| Group / item | … | journey / wording / order | … |
End with one paragraph summarizing the narrative arc of the sidebar after changes.
b683754
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.