Skip to content
prod e051e98
Browse

Type decisions

ZajLibrary organizes docs by topic first (category, subcategory, topic), then reader intent (shelf), then type (kind/folder). Plain English: put all material about one subject in one neighborhood, then sort that neighborhood into Learn, Build, and Resources.

app/src/content/docs/<category>/<subcategory>/<topic>/<shelf>/<kind>/...
LayerQuestion it answersExample
CategoryWhich broad subject family?tech-stack, infrastructure, zajlibrary
SubcategoryWhich area inside that family?laravel, hosting, authoring
TopicWhich exact content neighborhood?codecanyon, shared-hosting, content-system
ShelfWhat is the reader trying to do?learn, build, resources
KindWhat content type is this?guide, playbook, template, reference
ShelfQuestion it answersTypes
Learn & UnderstandWhat do I need to know?handbooks, guides, concepts, research, case-studies
Build & CreateWhat do I design and execute?playbooks, blueprints, sops, runbooks, checklists
ResourcesWhat can I copy, download, or glance at?templates, kits, cheatsheets, reference
TypeShelfOne-line job
HandbookLearnWhole-domain multi-page reference
GuideLearnOne focused topic — read to understand
ConceptLearnTheory / explainer / mental model
ResearchLearnFindings and sources
Case studyLearnReal-work example and lessons
PlaybookBuildFull multi-phase workflow — teach why → how
BlueprintBuildDesign before building — read, don’t execute yet
SOPBuildThe approved standard procedure (policy flavor)
RunbookBuildTerse commands + checks for one operation
ChecklistBuildVerification list — did every step happen?
TemplateResourcesCopy-and-fill starter
KitResourcesBundled reusable assets
Cheat sheetResourcesGlanceable lookup
ReferenceResourcesSite authoring (capabilities, style, components)

Learn answers “What do I need to understand?” Build answers “What do I execute?” Guides and playbooks both contain steps, which is why beginners mix them up. The split is intent, not step count:

ShelfReader modeTypical types
LearnStudy once, build mental modelguide, handbook, concept, research, case study
BuildFollow through, ship an outcomeplaybook, blueprint, SOP, runbook, checklist

A guide teaches one focused thing on the Learn shelf. A playbook is the full teaching journey for a workflow on the Build shelf — multi-phase, narrative, gates, beginner-friendly. When you are ready to do the whole job, promote to a playbook; don’t park execution docs on Learn just because they have numbered steps.


Build shelf — playbook, runbook, SOP (and neighbors)

Section titled “Build shelf — playbook, runbook, SOP (and neighbors)”

These three overlap in real projects. They are distinct on purpose — same workflow, different reader moment:

graph TD
  subgraph moment["Reader moment"]
    Q1["I need the full journey — teach me why and how"]
    Q2["I already know the drill — give me exact commands"]
    Q3["What is the official approved way we do this?"]
  end
  Q1 --> PB["Playbook"]
  Q2 --> RB["Runbook"]
  Q3 --> SOP["SOP"]
  PB -->|"one phase gets linkable"| RB
  PB -->|"method frozen as policy"| SOP
  PB --> CL["Checklist"]
  RB --> CL
  SOP --> CL

The full teaching journey for a workflow. Multi-phase, narrative, why → how, gates, beginner-friendly. The reader may be new to the outcome; the doc carries judgment calls, context, and “what if” branches.

  • Voice: patient teacher — explain before you command.
  • Shape: folder of phases (01-…, 02-…), optional progress/stepper, links outward to Learn guides for depth.
  • Example: Laravel/CodeCanyon — ZIP → local → staging → production (WF1–WF5 style journeys).
  • Not: a single-operation command card (that’s a runbook) or a compliance PDF tone (that’s an SOP).

A terse “exact commands + checks” card for one operation when you already know the drill. Think emergency checklist or incident steps — no teaching, minimal prose.

  • Voice: operator card — imperative steps, copy-paste commands, pass/fail checks.
  • Shape: usually one short page; peeled from a playbook phase when that phase is linkable on its own (rollback, restore, DNS cutover).
  • Example: “Production rollback — run these 8 commands and verify these 4 signals.”
  • Not: the whole onboarding story (playbook) or the org-wide policy doc (SOP).

The formal “this is THE approved procedure” flavor — compliance-ish, canonical, org-wide. Less narrative than a playbook; more “we always do it this way” than “let me teach you.”

  • Voice: policy-backed standard — roles, prerequisites, required evidence, audit trail.
  • Shape: one file or small folder; often pairs with a checklist for sign-off.
  • Use sparingly in solo-founder libraries — most execution docs should be playbooks or runbooks. Reserve SOP when repeatability and approval matter (regulated ops, client handoff, team onboarding to a frozen method).

Blueprint and checklist (often paired with the three above)

Section titled “Blueprint and checklist (often paired with the three above)”
TypeJobvs playbook / runbook / SOP
BlueprintDesign before you build — architecture, boundaries, decisionsRead to align; you don’t “run” it like a playbook
ChecklistVerify every step was done — gates, QA, releaseAttaches to any Build type; not a substitute for teaching or commands

Learn shelf — guide vs handbook (and vs playbook)

Section titled “Learn shelf — guide vs handbook (and vs playbook)”
TypeJobvs playbook
GuideOne focused how-to — read top to bottom, learn one topicPlaybook = re-read every time you execute the full outcome; guide = read once to understand
HandbookWhole-domain hub — many pages, browse by subtopicPlaybook = phased execution path; handbook = reference spine
ConceptMental model / theory — why something existsPlaybook may link concepts; concepts don’t replace phases
ResearchFindings, sources, evidenceInforms blueprints and playbooks; not an execution doc
Case studyWhat happened in a real instanceLessons inform playbooks; not a runnable procedure
graph LR
  subgraph learn["Learn — understand"]
    C["Concept"]
    G["Guide"]
    H["Handbook"]
  end
  subgraph build["Build — execute"]
    BP["Blueprint"]
    PB["Playbook"]
    RB["Runbook"]
  end
  C --> G
  G -->|"outcome needs phased execution"| PB
  H -->|"one chapter is runnable"| G
  BP --> PB
  PB -.->|"deep link"| G
  PB -->|"peel one op"| RB

Use the first row that matches. If two match, prefer the narrower type (runbook over playbook; guide over handbook).

You need…TypeShelf
Explain what X means and why it mattersConceptLearn
One focused how-to — read to learn, not a full project journeyGuideLearn
Everything about a domain in one browsable hubHandbookLearn
Design / architecture before anyone runs commandsBlueprintBuild
Full workflow — phases, why, gates, beginner can follow start to finishPlaybookBuild
One operation — exact commands and checks, no teachingRunbookBuild
Approved standard — the canonical org methodSOPBuild
Tick-box verification that steps were completedChecklistBuild
Empty structure to copyTemplateResources
Glanceable facts or commandsCheat sheetResources
PairRule
Playbook vs GuideRe-read every time you execute the full outcome → Playbook. Read once to learn one topic → Guide.
Playbook vs RunbookWhole journey with teaching → Playbook. Single operation, commands only → Runbook.
SOP vs RunbookApproved standard / policy → SOP. Literal commands and checks in the moment → Runbook.
SOP vs PlaybookPlaybook teaches and phases; SOP states the frozen approved method with less narrative.
Playbook vs BlueprintBlueprint = what to build and how it’s structured. Playbook = how to execute building it.
Guide vs HandbookOne topic → Guide. Whole area with many entry points → Handbook.
Checklist vs RunbookChecklist = verify. Runbook = do (commands). Often used together.

Promotion path (when a doc outgrows its type)

Section titled “Promotion path (when a doc outgrows its type)”
  1. Guide → Handbook when one guide sprouts 3+ linkable subtopics worth their own pages.
  2. Guide → Playbook when the reader must follow phases with gates every time they ship the outcome (move to Build).
  3. Playbook phase → Runbook when one phase is linkable as a standalone command card (rollback, restore, cutover).
  4. Playbook → SOP when the method is frozen, approved, and policy-backed (rare for solo workflows).
  5. Any Build doc → Checklist when you need a gate list readers tick through at phase boundaries.

Deeper synonym tables and naming rules: Content types (system docs).

ViewSource metadataRoute
Categorycategory:/categories/<category>/
Subcategorysubcategory:/subcategories/<subcategory>/
Topic foldertopic: + physical path/browse/ topic row
Tagtags:/tags/<tag>/
  1. One topic home per subject — add or enrich under the existing <category>/<subcategory>/<topic>/ path when the topic already exists.
  2. One type folder per file — never mix playbooks and handbooks in the same directory.
  3. Topic is a path segment — use category, subcategory, and topic for the physical home; use tags for cross-cutting filters.
  4. Reference is site-only — framework handbooks (Mastra) live under the relevant topic’s learn/handbooks/; authoring docs live under zajlibrary/authoring/content-system/resources/reference/.
  5. Promote when dense — a guide with 3+ linkable sections becomes a handbook folder; a long playbook procedure becomes a runbook or SOP.
kind: guide
collection: mastra
category: ai-systems
subcategory: agent-frameworks
topic: mastra
tags: [mastra, storage, rag]

collection is optional metadata for legacy grouping and prompt context. Category/subcategory/topic define the path; tags are cross-cutting filters.

Section titled “URL map (legacy paths — fix links, no redirects)”

The topic-first cutover is a hard cutover. Redirect helpers are archived, so after a move, grep and update every internal link to the canonical path:

Old path (do not link)Canonical path
/build/playbooks/laravel/codecanyon/setup-new/…/tech-stack/laravel/codecanyon/build/playbooks/setup-new/…
/learn/guides/servers/shared-hosting/…/infrastructure/hosting/shared-hosting/learn/guides/…
/resources/reference/meta/authoring/writing-style//zajlibrary/authoring/content-system/resources/reference/writing-style/
/system_docs/platform-architecture//zajlibrary/system/platform/resources/reference/platform-architecture/
/collections/<collection>//browse/ or the topic hub, for example /tech-stack/laravel/codecanyon/

Verify: python3 scripts/content-path-audit.py then cd app && npm run build (Starlight link validator).

Processing _INBOX/ or updating a page from research follows AGENTS.md → “Inbox processing” and the content-intake skill — file-by-file classify, corpus check, multi-extract, mandatory ledger row in _INBOX/2-Research/<topic>/COVERAGE.md. First choose or create the topic-first home, then dispatch starlight-content-author + matching type-* skill; CodeCanyon corpus also loads specialized-codecanyon-laravel.