Agentic AI Atlasby a5c.ai
OverviewWikiGraphFor AgentsEdgesSearchWorkspace
/
GitHubDocsDiscord
iiRecord
Agentic AI Atlas · Babysitter User Documentation - Information Architecture
page:docs-user-guide-03-information-architecturea5c.ai
Search record views/
Record · tabs

Available views

II.Record viewspp. 1 - 1
overviewarticlejsongraph
II.
Page JSON

page:docs-user-guide-03-information-architecture

Structured · live

Babysitter User Documentation - Information Architecture json

Inspect the normalized record payload exactly as the atlas UI reads it.

File · wiki/docs/user-guide/03-information-architecture.mdCluster · wiki
Record JSON
{
  "id": "page:docs-user-guide-03-information-architecture",
  "_kind": "Page",
  "_file": "wiki/docs/user-guide/03-information-architecture.md",
  "_cluster": "wiki",
  "attributes": {
    "nodeKind": "Page",
    "sourcePath": "docs/user-guide/03-information-architecture.md",
    "sourceKind": "repo-docs",
    "title": "Babysitter User Documentation - Information Architecture",
    "displayName": "Babysitter User Documentation - Information Architecture",
    "slug": "docs/user-guide/03-information-architecture",
    "articlePath": "wiki/docs/user-guide/03-information-architecture.md",
    "article": "\n# Babysitter User Documentation - Information Architecture\n\n**Version:** 1.0\n**Date:** 2026-01-25\n**Author:** Information Architecture Specialist\n**Status:** Complete\n**Framework:** Diataxis (Tutorials, How-to Guides, Reference, Explanation)\n**Related Documents:**\n- [01-discovery-analysis.md](./01-discovery-analysis.md)\n- [02-audience-personas.md](./02-audience-personas.md)\n\n---\n\n## Table of Contents\n\n1. [Diataxis Framework Application](#1-diataxis-framework-application)\n2. [Complete Sitemap](#2-complete-sitemap)\n3. [Navigation Menu Structure](#3-navigation-menu-structure)\n4. [Page Hierarchy](#4-page-hierarchy)\n5. [Breadcrumb Navigation](#5-breadcrumb-navigation)\n6. [Cross-Reference Strategy](#6-cross-reference-strategy)\n7. [Content Templates](#7-content-templates)\n8. [Implementation Guidelines](#8-implementation-guidelines)\n\n---\n\n## 1. Diataxis Framework Application\n\n### 1.1 Framework Overview\n\nThe Diataxis framework organizes documentation into four distinct categories based on user needs:\n\n| Category | Orientation | User Mode | Content Purpose |\n|----------|-------------|-----------|-----------------|\n| **Tutorials** | Learning | Study | Guided lessons for acquiring skills |\n| **How-to Guides** | Task | Work | Practical steps to solve problems |\n| **Reference** | Information | Work | Technical descriptions and specifications |\n| **Explanation** | Understanding | Study | Conceptual background and context |\n\n### 1.2 Category Definitions for Babysitter\n\n#### Tutorials (Learning-Oriented)\n\n**Purpose:** Take users by the hand through a series of steps to complete a project.\n\n**Characteristics:**\n- Learning-focused, not task-focused\n- Safe learning environment\n- Immediate sense of achievement\n- Repeatable and reliable outcomes\n- Concrete, not abstract\n\n**Babysitter Application:**\n- Getting started from zero to first successful run\n- Building complete features step-by-step\n- Progressive skill building\n- Safe experimentation environments\n\n**Primary Personas:** James Park (beginner), Sarah Chen (onboarding)\n\n---\n\n#### How-to Guides (Task-Oriented)\n\n**Purpose:** Take users through steps to solve a real-world problem.\n\n**Characteristics:**\n- Goal-focused (solve a specific problem)\n- Series of practical steps\n- Assumes some knowledge\n- Addresses a specific question or need\n- Flexible enough for variations\n\n**Babysitter Application:**\n- Configuring breakpoints for specific use cases\n- Resuming interrupted sessions\n- Integrating with CI/CD pipelines\n- Troubleshooting specific issues\n- Optimizing quality convergence\n\n**Primary Personas:** Sarah Chen (daily use), Elena Rodriguez (automation), Marcus Thompson (governance)\n\n---\n\n#### Reference (Information-Oriented)\n\n**Purpose:** Provide technical descriptions of the machinery and how to operate it.\n\n**Characteristics:**\n- Information-oriented\n- Describes the machinery\n- Accurate and complete\n- Structured consistently\n- Austere and to the point\n\n**Babysitter Application:**\n- CLI command reference\n- API documentation\n- Configuration options\n- Environment variables\n- Exit codes and error messages\n- File structure specifications\n- JSON schemas\n\n**Primary Personas:** Elena Rodriguez (automation), all personas for lookup\n\n---\n\n#### Explanation (Understanding-Oriented)\n\n**Purpose:** Clarify and illuminate a particular topic.\n\n**Characteristics:**\n- Understanding-oriented\n- Explains background and context\n- Discusses alternatives and opinions\n- Provides reasoning and connections\n- Illuminates the subject\n\n**Babysitter Application:**\n- Event sourcing and journal system concepts\n- Quality convergence philosophy\n- Why human-in-the-loop matters\n- Architecture decisions and trade-offs\n- Methodology comparisons and rationale\n\n**Primary Personas:** Marcus Thompson (governance), James Park (foundational), Sarah Chen (optimization decisions)\n\n---\n\n### 1.3 Content Mapping by Diataxis Category\n\n| Existing/Planned Content | Diataxis Category | Rationale |\n|-------------------------|-------------------|-----------|\n| First Run Tutorial | Tutorial | Learning through doing |\n| Installation Guide | Tutorial | Guided setup process |\n| Build a Todo App | Tutorial | Complete project learning |\n| Configure Breakpoints | How-to | Specific task completion |\n| Resume Interrupted Work | How-to | Problem-solving guide |\n| CI/CD Integration | How-to | Task-oriented automation |\n| Troubleshooting Guide | How-to | Problem-solution format |\n| CLI Reference | Reference | Technical specification |\n| API Reference | Reference | Technical specification |\n| Glossary | Reference | Term definitions |\n| Configuration Reference | Reference | Settings specification |\n| Event Sourcing Explained | Explanation | Conceptual understanding |\n| Quality Convergence | Explanation | Philosophy and rationale |\n| Architecture Overview | Explanation | System understanding |\n| Methodology Comparison | Explanation | Decision-making context |\n\n---\n\n## 2. Complete Sitemap\n\n### 2.1 Sitemap by Diataxis Category\n\n```\ndocs/\n|\n+-- index.md                              # Landing page / documentation home\n|\n+-- tutorials/                            # LEARNING-ORIENTED\n|   |\n|   +-- index.md                          # Tutorials overview\n|   |\n|   +-- getting-started/                  # Level 1: Beginner Tutorials\n|   |   +-- index.md                      # Getting started overview\n|   |   +-- prerequisites.md              # Environment preparation\n|   |   +-- installation.md               # Step-by-step installation\n|   |   +-- your-first-run.md             # First babysitter execution\n|   |   +-- understanding-results.md      # Reading run output and artifacts\n|   |\n|   +-- building-features/                # Level 2: Intermediate Tutorials\n|   |   +-- index.md                      # Building features overview\n|   |   +-- tdd-calculator.md             # Build calculator with TDD\n|   |   +-- todo-api.md                   # Build a todo API end-to-end\n|   |   +-- auth-feature.md               # Add authentication with TDD\n|   |   +-- refactoring-legacy.md         # Refactor legacy code safely\n|   |\n|   +-- advanced-projects/                # Level 3: Advanced Tutorials\n|       +-- index.md                      # Advanced projects overview\n|       +-- ci-integration-tutorial.md    # GitHub Actions integration project\n|       +-- team-onboarding.md            # Onboard your team tutorial\n|       +-- custom-process-tutorial.md    # Create your first custom process\n|\n+-- how-to/                               # TASK-ORIENTED\n|   |\n|   +-- index.md                          # How-to guides overview\n|   |\n|   +-- workflows/                        # Workflow How-tos\n|   |   +-- index.md                      # Workflows overview\n|   |   +-- resume-interrupted-work.md    # Resume after session ends\n|   |   +-- manage-multiple-runs.md       # Work with several concurrent runs\n|   |   +-- review-run-history.md         # Analyze past runs via journal\n|   |   +-- cancel-running-workflow.md    # Stop a workflow in progress\n|   |\n|   +-- quality/                          # Quality Management How-tos\n|   |   +-- index.md                      # Quality management overview\n|   |   +-- set-quality-targets.md        # Configure quality thresholds\n|   |   +-- tune-iteration-limits.md      # Optimize max iterations\n|   |   +-- customize-scoring.md          # Adjust quality scoring criteria\n|   |   +-- debug-quality-issues.md       # When quality doesn't converge\n|   |\n|   +-- integration/                      # Integration How-tos\n|   |   +-- index.md                      # Integration overview\n|   |   +-- github-actions.md             # GitHub Actions CI/CD\n|   |   +-- gitlab-ci.md                  # GitLab CI integration\n|   |   +-- jenkins.md                    # Jenkins pipeline integration\n|   |   +-- scripting-with-cli.md         # Bash/shell automation\n|   |   +-- node-sdk-automation.md        # Node.js programmatic use\n|   |\n|   +-- methodologies/                    # Methodology How-tos\n|   |   +-- index.md                      # Methodologies overview\n|   |   +-- use-tdd-workflow.md           # TDD quality convergence\n|   |   +-- use-gsd-workflow.md           # Get Shit Done rapid mode\n|   |   +-- use-spec-kit.md               # Specification-driven workflow\n|   |   +-- choose-methodology.md         # Select the right approach\n|   |\n|   +-- troubleshooting/                  # Troubleshooting How-tos\n|   |   +-- index.md                      # Troubleshooting overview\n|   |   +-- installation-issues.md        # Fix installation problems\n|   |   +-- runtime-errors.md             # Resolve runtime issues\n|   |   +-- breakpoint-issues.md          # Breakpoint not resolving\n|   |   +-- performance-problems.md       # Slow iterations, memory issues\n|   |   +-- journal-recovery.md           # Recover from journal corruption\n|   |\n|   +-- customization/                    # Customization How-tos\n|       +-- index.md                      # Customization overview\n|       +-- create-custom-process.md      # Build a process definition\n|       +-- create-custom-hooks.md        # Develop lifecycle hooks\n|       +-- create-team-templates.md      # Shared team process templates\n|       +-- extend-quality-scoring.md     # Custom quality evaluators\n|\n+-- reference/                            # INFORMATION-ORIENTED\n|   |\n|   +-- index.md                          # Reference overview\n|   |\n|   +-- cli/                              # CLI Reference\n|   |   +-- index.md                      # CLI overview\n|   |   +-- run-create.md                 # run:create command\n|   |   +-- run-iterate.md                # run:iterate command\n|   |   +-- run-status.md                 # run:status command\n|   |   +-- run-list.md                   # run:list command\n|   |   +-- run-cancel.md                 # run:cancel command\n|   |   +-- effects-get.md                # effects:get command\n|   |   +-- effects-post.md               # effects:post command\n|   |   +-- journal-commands.md           # journal:* commands\n|   |   +-- global-options.md             # Global CLI flags\n|   |   +-- exit-codes.md                 # Exit codes reference\n|   |   +-- output-formats.md             # JSON/text output schemas\n|   |\n|   +-- api/                              # SDK API Reference\n|   |   +-- index.md                      # API overview\n|   |   +-- babysitter-class.md           # Main Babysitter class\n|   |   +-- run-class.md                  # Run object API\n|   |   +-- journal-api.md                # Journal access API\n|   |   +-- effect-types.md               # Effect type specifications\n|   |   +-- task-types.md                 # Task type specifications\n|   |   +-- event-types.md                # Event type definitions\n|   |\n|   +-- configuration/                    # Configuration Reference\n|   |   +-- index.md                      # Configuration overview\n|   |   +-- environment-variables.md      # All env vars\n|   |   +-- config-files.md               # Configuration file formats\n|   |   +-- process-parameters.md         # Process definition parameters\n|   |   +-- breakpoint-config.md          # Breakpoint service configuration\n|   |\n|   +-- file-structure/                   # File Structure Reference\n|   |   +-- index.md                      # File structure overview\n|   |   +-- run-directory.md              # .a5c/runs/<runId>/ structure\n|   |   +-- journal-format.md             # Journal file format\n|   |   +-- state-file.md                 # State.json specification\n|   |   +-- artifact-types.md             # Artifact file types\n|   |\n|   +-- glossary.md                       # Complete terminology reference\n|   +-- error-catalog.md                  # All error messages and solutions\n|   +-- keyboard-shortcuts.md             # UI and CLI shortcuts\n|   +-- version-history.md                # Changelog and migration guides\n|\n+-- explanation/                          # UNDERSTANDING-ORIENTED\n|   |\n|   +-- index.md                          # Explanation overview\n|   |\n|   +-- core-concepts/                    # Foundational Concepts\n|   |   +-- index.md                      # Core concepts overview\n|   |   +-- what-is-babysitter.md         # Introduction and positioning\n|   |   +-- event-sourcing.md             # Event sourcing explained\n|   |   +-- quality-convergence.md        # Iterative quality improvement\n|   |   +-- human-in-the-loop.md          # Why human approval matters\n|   |   +-- deterministic-execution.md    # Predictability and replay\n|   |\n|   +-- architecture/                     # Architecture Concepts\n|   |   +-- index.md                      # Architecture overview\n|   |   +-- system-architecture.md        # High-level system design\n|   |   +-- journal-system.md             # Journal internals and design\n|   |   +-- process-engine.md             # Process execution engine\n|   |   +-- task-execution.md             # How tasks are executed\n|   |   +-- breakpoint-architecture.md    # Breakpoint system design\n|   |\n|   +-- methodologies/                    # Methodology Concepts\n|   |   +-- index.md                      # Methodology philosophy\n|   |   +-- tdd-philosophy.md             # Why TDD with AI\n|   |   +-- gsd-philosophy.md             # When speed matters\n|   |   +-- spec-kit-philosophy.md        # Specification-driven rationale\n|   |   +-- methodology-comparison.md     # Detailed comparison\n|   |\n|   +-- governance/                       # Governance and Compliance\n|   |   +-- index.md                      # Governance overview\n|   |   +-- audit-trails.md               # Audit trail design and usage\n|   |   +-- compliance-patterns.md        # Meeting compliance requirements\n|   |   +-- security-model.md             # Security boundaries and trust\n|   |   +-- access-control.md             # Permission and access patterns\n|   |\n|   +-- best-practices/                   # Best Practices\n|       +-- index.md                      # Best practices overview\n|       +-- workflow-patterns.md          # Effective workflow patterns\n|       +-- quality-optimization.md       # Optimizing for quality\n|       +-- team-adoption.md              # Team rollout strategies\n|       +-- process-design.md             # Custom process best practices\n```\n\n### 2.2 Sitemap Statistics\n\n| Category | Level 1 Sections | Level 2 Topics | Total Pages |\n|----------|------------------|----------------|-------------|\n| Tutorials | 3 | 14 | 18 |\n| How-to Guides | 7 | 35 | 43 |\n| Reference | 5 | 27 | 36 |\n| Explanation | 5 | 22 | 28 |\n| **Total** | **20** | **98** | **125** |\n\n---\n\n## 3. Navigation Menu Structure\n\n### 3.1 Primary Navigation (Top-Level)\n\n```\n+------------------------------------------------------------------+\n|  [Logo] Babysitter Docs                                           |\n+------------------------------------------------------------------+\n|  Tutorials  |  How-to Guides  |  Reference  |  Explanation  | [Search] |\n+------------------------------------------------------------------+\n```\n\n### 3.2 Secondary Navigation (Category-Level Sidebars)\n\n#### Tutorials Sidebar\n\n```\nTUTORIALS\n\nGetting Started\n  - Overview\n  - Prerequisites\n  - Installation\n  - Your First Run\n  - Understanding Results\n\nBuilding Features\n  - Overview\n  - TDD Calculator\n  - Todo API\n  - Auth Feature\n  - Refactoring Legacy Code\n\nAdvanced Projects\n  - Overview\n  - CI Integration Tutorial\n  - Team Onboarding\n  - Custom Process Tutorial\n```\n\n#### How-to Guides Sidebar\n\n```\nHOW-TO GUIDES\n\nWorkflows\n  - Overview\n  - Resume Interrupted Work\n  - Manage Multiple Runs\n  - Review Run History\n  - Cancel Running Workflow\n\nQuality Management\n  - Overview\n  - Set Quality Targets\n  - Tune Iteration Limits\n  - Customize Scoring\n  - Debug Quality Issues\n\nIntegration\n  - Overview\n  - GitHub Actions\n  - GitLab CI\n  - Jenkins\n  - Scripting with CLI\n  - Node SDK Automation\n\nMethodologies\n  - Overview\n  - Use TDD Workflow\n  - Use GSD Workflow\n  - Use Spec-Kit\n  - Choose Methodology\n\nTroubleshooting\n  - Overview\n  - Installation Issues\n  - Runtime Errors\n  - Breakpoint Issues\n  - Performance Problems\n  - Journal Recovery\n\nCustomization\n  - Overview\n  - Create Custom Process\n  - Create Custom Hooks\n  - Create Team Templates\n  - Extend Quality Scoring\n```\n\n#### Reference Sidebar\n\n```\nREFERENCE\n\nCLI Reference\n  - Overview\n  - run:create\n  - run:iterate\n  - run:status\n  - run:list\n  - run:cancel\n  - effects:get\n  - effects:post\n  - journal:* Commands\n  - Global Options\n  - Exit Codes\n  - Output Formats\n\nSDK API\n  - Overview\n  - Babysitter Class\n  - Run Class\n  - Journal API\n  - Effect Types\n  - Task Types\n  - Event Types\n\nConfiguration\n  - Overview\n  - Environment Variables\n  - Config Files\n  - Process Parameters\n  - Breakpoint Config\n\nFile Structure\n  - Overview\n  - Run Directory\n  - Journal Format\n  - State File\n  - Artifact Types\n\nQuick Reference\n  - Glossary\n  - Error Catalog\n  - Keyboard Shortcuts\n  - Version History\n```\n\n#### Explanation Sidebar\n\n```\nEXPLANATION\n\nCore Concepts\n  - Overview\n  - What is Babysitter?\n  - Event Sourcing\n  - Quality Convergence\n  - Human-in-the-Loop\n  - Deterministic Execution\n\nArchitecture\n  - Overview\n  - System Architecture\n  - Journal System\n  - Process Engine\n  - Task Execution\n  - Breakpoint Architecture\n\nMethodologies\n  - Overview\n  - TDD Philosophy\n  - GSD Philosophy\n  - Spec-Kit Philosophy\n  - Methodology Comparison\n\nGovernance\n  - Overview\n  - Audit Trails\n  - Compliance Patterns\n  - Security Model\n  - Access Control\n\nBest Practices\n  - Overview\n  - Workflow Patterns\n  - Quality Optimization\n  - Team Adoption\n  - Process Design\n```\n\n### 3.3 Mobile Navigation\n\n```\n+---------------------------+\n| [Hamburger] Babysitter    |\n+---------------------------+\n| [Search icon]             |\n+---------------------------+\n\n[Hamburger expanded:]\n+---------------------------+\n| Tutorials           [>]   |\n| How-to Guides       [>]   |\n| Reference           [>]   |\n| Explanation         [>]   |\n+---------------------------+\n| Quick Links               |\n| - Getting Started         |\n| - CLI Reference           |\n| - Glossary                |\n+---------------------------+\n```\n\n### 3.4 Footer Navigation\n\n```\n+------------------------------------------------------------------+\n| Tutorials          | How-to          | Reference    | Explanation |\n| - Getting Started  | - Workflows     | - CLI        | - Concepts  |\n| - Building         | - Quality       | - API        | - Architecture |\n|   Features         | - Breakpoints   | - Config     | - Methodologies |\n| - Advanced         | - Integration   | - Files      | - Governance |\n|   Projects         | - Troubleshoot  | - Glossary   | - Best Practices |\n+------------------------------------------------------------------+\n| Resources                                                          |\n| GitHub | Community | Blog | Changelog | Support                   |\n+------------------------------------------------------------------+\n```\n\n---\n\n## 4. Page Hierarchy\n\n### 4.1 Tutorials Hierarchy\n\n```\nTUTORIALS\n|\n+-- Level 1: Getting Started (Beginner)\n|   |\n|   +-- L1.1 Prerequisites\n|   |   +-- Node.js requirements\n|   |   +-- Claude Code setup\n|   |   +-- Optional tools\n|   |   +-- Knowledge checklist\n|   |\n|   +-- L1.2 Installation\n|   |   +-- SDK installation\n|   |   +-- Plugin installation\n|   |   +-- Verification steps\n|   |\n|   +-- L1.3 Your First Run\n|   |   +-- Starting Claude Code\n|   |   +-- Running /babysitter:call command\n|   |   +-- Observing iteration\n|   |   +-- Viewing results\n|   |\n|   +-- L1.4 Understanding Results\n|       +-- Run directory structure\n|       +-- Reading the journal\n|       +-- Viewing artifacts\n|       +-- Quality scores\n|\n+-- Level 2: Building Features (Intermediate)\n|   |\n|   +-- L2.1 TDD Calculator\n|   |   +-- Project setup\n|   |   +-- Defining requirements\n|   |   +-- Running TDD workflow\n|   |   +-- Test-first iteration\n|   |   +-- Quality convergence\n|   |   +-- Final review\n|   |\n|   +-- L2.2 Todo API\n|   |   +-- API design\n|   |   +-- Database setup\n|   |   +-- Endpoint creation\n|   |   +-- Testing integration\n|   |   +-- Breakpoint approval\n|   |   +-- Deployment preparation\n|   |\n|   +-- L2.3 Auth Feature\n|   |   +-- JWT concepts\n|   |   +-- Security requirements\n|   |   +-- TDD implementation\n|   |   +-- Security review breakpoint\n|   |   +-- Integration testing\n|   |\n|   +-- L2.4 Refactoring Legacy Code\n|       +-- Analysis phase\n|       +-- Test coverage first\n|       +-- Incremental refactoring\n|       +-- Quality validation\n|       +-- Safe deployment\n|\n+-- Level 3: Advanced Projects (Expert)\n    |\n    +-- L3.1 CI Integration Tutorial\n    |   +-- GitHub Actions setup\n    |   +-- Workflow configuration\n    |   +-- Automated quality gates\n    |   +-- Breakpoint handling in CI\n    |   +-- Reporting and notifications\n    |\n    +-- L3.2 Team Onboarding\n    |   +-- Planning rollout\n    |   +-- Creating team processes\n    |   +-- Training materials\n    |   +-- Governance setup\n    |   +-- Success metrics\n    |\n    +-- L3.3 Custom Process Tutorial\n        +-- Process definition basics\n        +-- Task orchestration\n        +-- Quality scoring\n        +-- Breakpoint integration\n        +-- Testing and deployment\n```\n\n### 4.2 How-to Guides Hierarchy\n\n```\nHOW-TO GUIDES\n|\n+-- Workflows\n|   +-- Resume Interrupted Work\n|   |   +-- Identifying paused runs\n|   |   +-- Resume command\n|   |   +-- State verification\n|   |\n|   +-- Manage Multiple Runs\n|   |   +-- Listing active runs\n|   |   +-- Switching contexts\n|   |   +-- Run isolation\n|   |\n|   +-- Review Run History\n|   |   +-- Journal exploration\n|   |   +-- Event filtering\n|   |   +-- Artifact analysis\n|   |\n|   +-- Cancel Running Workflow\n|       +-- Graceful cancellation\n|       +-- Force stop\n|       +-- Cleanup procedures\n|\n+-- Quality Management\n|   +-- Set Quality Targets\n|   |   +-- Target selection\n|   |   +-- Per-process configuration\n|   |   +-- Dynamic adjustment\n|   |\n|   +-- Tune Iteration Limits\n|   |   +-- Max iterations setting\n|   |   +-- Early exit conditions\n|   |   +-- Performance balance\n|   |\n|   +-- Customize Scoring\n|   |   +-- Scoring criteria\n|   |   +-- Weight adjustment\n|   |   +-- Custom evaluators\n|   |\n|   +-- Debug Quality Issues\n|       +-- Score analysis\n|       +-- Iteration review\n|       +-- Target adjustment\n|\n|\n+-- Integration\n|   +-- GitHub Actions\n|   |   +-- Workflow file setup\n|   |   +-- Secrets configuration\n|   |   +-- Job definitions\n|   |   +-- Artifact handling\n|   |\n|   +-- GitLab CI\n|   |   +-- .gitlab-ci.yml setup\n|   |   +-- Variables configuration\n|   |   +-- Stage definitions\n|   |\n|   +-- Jenkins\n|   |   +-- Jenkinsfile creation\n|   |   +-- Credentials setup\n|   |   +-- Pipeline stages\n|   |\n|   +-- Scripting with CLI\n|   |   +-- Bash patterns\n|   |   +-- JSON parsing\n|   |   +-- Error handling\n|   |\n|   +-- Node SDK Automation\n|       +-- SDK installation\n|       +-- Programmatic usage\n|       +-- Event handling\n|\n+-- Methodologies\n|   +-- Use TDD Workflow\n|   |   +-- Process selection\n|   |   +-- Configuration\n|   |   +-- Execution\n|   |\n|   +-- Use GSD Workflow\n|   |   +-- When to use GSD\n|   |   +-- Configuration\n|   |   +-- Speed optimization\n|   |\n|   +-- Use Spec-Kit\n|   |   +-- Specification input\n|   |   +-- Configuration\n|   |   +-- Validation\n|   |\n|   +-- Choose Methodology\n|       +-- Decision criteria\n|       +-- Comparison table\n|       +-- Recommendations\n|\n+-- Troubleshooting\n|   +-- Installation Issues\n|   |   +-- CLI not found\n|   |   +-- Plugin not appearing\n|   |   +-- Version mismatches\n|   |\n|   +-- Runtime Errors\n|   |   +-- Session timeouts\n|   |   +-- API errors\n|   |   +-- Memory issues\n|   |\n|   +-- Breakpoint Issues\n|   |   +-- Service not starting\n|   |   +-- Approval not resolving\n|   |   +-- Connection problems\n|   |\n|   +-- Performance Problems\n|   |   +-- Slow iterations\n|   |   +-- High memory usage\n|   |   +-- Large journal files\n|   |\n|   +-- Journal Recovery\n|       +-- Corruption detection\n|       +-- State rebuild\n|       +-- Manual recovery\n|\n+-- Customization\n    +-- Create Custom Process\n    |   +-- Process structure\n    |   +-- Task definitions\n    |   +-- Testing\n    |\n    +-- Create Custom Hooks\n    |   +-- Hook types\n    |   +-- Implementation\n    |   +-- Registration\n    |\n    +-- Create Team Templates\n    |   +-- Template design\n    |   +-- Parameterization\n    |   +-- Distribution\n    |\n    +-- Extend Quality Scoring\n        +-- Evaluator interface\n        +-- Custom metrics\n        +-- Integration\n```\n\n### 4.3 Reference Hierarchy\n\n```\nREFERENCE\n|\n+-- CLI Reference\n|   +-- run:create\n|   |   +-- Synopsis\n|   |   +-- Options\n|   |   +-- Examples\n|   |   +-- Exit codes\n|   |\n|   +-- run:iterate\n|   |   +-- Synopsis\n|   |   +-- Options\n|   |   +-- Examples\n|   |   +-- Exit codes\n|   |\n|   +-- run:status\n|   |   +-- Synopsis\n|   |   +-- Options\n|   |   +-- Output format\n|   |\n|   +-- run:list\n|   |   +-- Synopsis\n|   |   +-- Filtering options\n|   |   +-- Output format\n|   |\n|   +-- run:cancel\n|   |   +-- Synopsis\n|   |   +-- Options\n|   |   +-- Behavior\n|   |\n|   +-- effects:get\n|   |   +-- Synopsis\n|   |   +-- Options\n|   |   +-- Output format\n|   |\n|   +-- effects:post\n|   |   +-- Synopsis\n|   |   +-- Options\n|   |   +-- Input format\n|   |\n|   +-- journal:* Commands\n|   |   +-- journal:list\n|   |   +-- journal:get\n|   |   +-- journal:export\n|   |\n|   +-- Global Options\n|   |   +-- --help\n|   |   +-- --version\n|   |   +-- --json\n|   |   +-- --verbose\n|   |   +-- --cwd\n|   |\n|   +-- Exit Codes\n|   |   +-- Success codes\n|   |   +-- Error codes\n|   |   +-- Signal handling\n|   |\n|   +-- Output Formats\n|       +-- JSON schema\n|       +-- Text format\n|       +-- Table format\n|\n+-- SDK API Reference\n|   +-- Babysitter Class\n|   |   +-- Constructor\n|   |   +-- Methods\n|   |   +-- Properties\n|   |   +-- Events\n|   |\n|   +-- Run Class\n|   |   +-- Properties\n|   |   +-- Methods\n|   |   +-- State transitions\n|   |\n|   +-- Journal API\n|   |   +-- Reading events\n|   |   +-- Writing events\n|   |   +-- Querying\n|   |\n|   +-- Effect Types\n|   |   +-- TaskEffect\n|   |   +-- BreakpointEffect\n|   |   +-- SleepEffect\n|   |\n|   +-- Task Types\n|   |   +-- AgentTask\n|   |   +-- SkillTask\n|   |   +-- NodeTask\n|   |   +-- ShellTask\n|   |\n|   +-- Event Types\n|       +-- RunCreated\n|       +-- IterationStarted\n|       +-- EffectRequested\n|       +-- EffectCompleted\n|       +-- RunCompleted\n|\n+-- Configuration Reference\n|   +-- Environment Variables\n|   |   +-- BABYSITTER_*\n|   |   +-- A5C_*\n|   |   +-- NODE_*\n|   |\n|   +-- Config Files\n|   |   +-- .a5c/config.json\n|   |   +-- Process config\n|   |   +-- Breakpoint config\n|   |\n|   +-- Process Parameters\n|   |   +-- Required parameters\n|   |   +-- Optional parameters\n|   |   +-- Parameter types\n|   |\n|   +-- Breakpoint Config\n|       +-- Service settings\n|       +-- UI settings\n|       +-- Notification settings\n|\n+-- File Structure Reference\n|   +-- Run Directory\n|   |   +-- Directory layout\n|   |   +-- File purposes\n|   |   +-- Lifecycle\n|   |\n|   +-- Journal Format\n|   |   +-- File naming\n|   |   +-- Event structure\n|   |   +-- Ordering guarantees\n|   |\n|   +-- State File\n|   |   +-- Schema\n|   |   +-- Derivation rules\n|   |   +-- Caching behavior\n|   |\n|   +-- Artifact Types\n|       +-- Plans\n|       +-- Reports\n|       +-- Specs\n|       +-- Logs\n|\n+-- Quick Reference\n    +-- Glossary\n    |   +-- A-Z term definitions\n    |   +-- Related term links\n    |\n    +-- Error Catalog\n    |   +-- Error codes\n    |   +-- Error messages\n    |   +-- Resolution steps\n    |\n    +-- Keyboard Shortcuts\n    |   +-- CLI shortcuts\n    |   +-- UI shortcuts\n    |\n    +-- Version History\n        +-- Changelog\n        +-- Migration guides\n        +-- Deprecation notices\n```\n\n### 4.4 Explanation Hierarchy\n\n```\nEXPLANATION\n|\n+-- Core Concepts\n|   +-- What is Babysitter?\n|   |   +-- Problem statement\n|   |   +-- Solution overview\n|   |   +-- Key differentiators\n|   |   +-- Use case examples\n|   |\n|   +-- Event Sourcing\n|   |   +-- What is event sourcing?\n|   |   +-- Benefits for AI workflows\n|   |   +-- Journal as source of truth\n|   |   +-- State derivation\n|   |   +-- Replay and recovery\n|   |\n|   +-- Quality Convergence\n|   |   +-- The iteration loop\n|   |   +-- Quality scoring\n|   |   +-- Convergence criteria\n|   |   +-- When to stop iterating\n|   |\n|   +-- Human-in-the-Loop\n|   |   +-- Why human approval matters\n|   |   +-- Breakpoint philosophy\n|   |   +-- Trust and automation balance\n|   |   +-- Use case patterns\n|   |\n|   +-- Deterministic Execution\n|       +-- Reproducibility goals\n|       +-- Journal-based replay\n|       +-- Non-determinism handling\n|       +-- Testing implications\n|\n+-- Architecture\n|   +-- System Architecture\n|   |   +-- Component overview\n|   |   +-- Data flow\n|   |   +-- Integration points\n|   |   +-- Deployment options\n|   |\n|   +-- Journal System\n|   |   +-- Design principles\n|   |   +-- Append-only guarantees\n|   |   +-- Event ordering\n|   |   +-- Storage considerations\n|   |\n|   +-- Process Engine\n|   |   +-- Process lifecycle\n|   |   +-- Effect scheduling\n|   |   +-- Dependency management\n|   |   +-- Error handling\n|   |\n|   +-- Task Execution\n|   |   +-- Task types deep dive\n|   |   +-- Execution environment\n|   |   +-- Result handling\n|   |   +-- Retry behavior\n|   |\n|   +-- Breakpoint Architecture\n|       +-- Service design\n|       +-- Resolution flow\n|       +-- Persistence\n|       +-- Multi-approver patterns\n|\n+-- Methodologies\n|   +-- TDD Philosophy\n|   |   +-- Test-first rationale\n|   |   +-- AI and TDD synergy\n|   |   +-- Quality through tests\n|   |   +-- When TDD works best\n|   |\n|   +-- GSD Philosophy\n|   |   +-- Speed over perfection\n|   |   +-- Appropriate use cases\n|   |   +-- Trade-offs\n|   |\n|   +-- Spec-Kit Philosophy\n|   |   +-- Specification-driven development\n|   |   +-- Contract-first approach\n|   |   +-- Validation strategies\n|   |\n|   +-- Methodology Comparison\n|       +-- Feature matrix\n|       +-- Use case mapping\n|       +-- Decision framework\n|       +-- Hybrid approaches\n|\n+-- Governance\n|   +-- Audit Trails\n|   |   +-- Compliance requirements\n|   |   +-- What is logged\n|   |   +-- Retention policies\n|   |   +-- Access patterns\n|   |\n|   +-- Compliance Patterns\n|   |   +-- SOC 2 considerations\n|   |   +-- GDPR implications\n|   |   +-- Industry-specific guidance\n|   |\n|   +-- Security Model\n|   |   +-- Trust boundaries\n|   |   +-- Data handling\n|   |   +-- Network security\n|   |   +-- Secret management\n|   |\n|   +-- Access Control\n|       +-- Permission model\n|       +-- Role definitions\n|       +-- Enforcement points\n|\n+-- Best Practices\n    +-- Workflow Patterns\n    |   +-- Effective prompting\n    |   +-- Iteration optimization\n    |   +-- Breakpoint placement\n    |\n    +-- Quality Optimization\n    |   +-- Target setting\n    |   +-- Scoring tuning\n    |   +-- Convergence acceleration\n    |\n    +-- Team Adoption\n    |   +-- Rollout strategies\n    |   +-- Training approaches\n    |   +-- Success metrics\n    |\n    +-- Process Design\n        +-- Reusable patterns\n        +-- Parameterization\n        +-- Testing processes\n        +-- Versioning\n```\n\n---\n\n## 5. Breadcrumb Navigation\n\n### 5.1 Breadcrumb Format\n\n```\nHome > Category > Section > Page\n```\n\n### 5.2 Breadcrumb Examples\n\n| Page | Breadcrumb |\n|------|------------|\n| Installation Tutorial | `Docs > Tutorials > Getting Started > Installation` |\n| Resume Interrupted Work | `Docs > How-to Guides > Workflows > Resume Interrupted Work` |\n| run:create Command | `Docs > Reference > CLI > run:create` |\n| Event Sourcing Explained | `Docs > Explanation > Core Concepts > Event Sourcing` |\n| GitHub Actions Integration | `Docs > How-to Guides > Integration > GitHub Actions` |\n| Glossary | `Docs > Reference > Glossary` |\n\n### 5.3 Breadcrumb Implementation Rules\n\n1. **Maximum depth:** 4 levels (Home included)\n2. **Truncation:** On mobile, show `... > Section > Page`\n3. **Links:** All breadcrumb items except current page are links\n4. **Styling:** Current page in bold, separator is `>`\n5. **Schema markup:** Use BreadcrumbList schema for SEO\n\n### 5.4 Breadcrumb HTML Template\n\n```html\n<nav aria-label=\"Breadcrumb\" class=\"breadcrumb\">\n  <ol itemscope itemtype=\"https://schema.org/BreadcrumbList\">\n    <li itemprop=\"itemListElement\" itemscope itemtype=\"https://schema.org/ListItem\">\n      <a itemprop=\"item\" href=\"/docs/\">\n        <span itemprop=\"name\">Docs</span>\n      </a>\n      <meta itemprop=\"position\" content=\"1\" />\n    </li>\n    <li itemprop=\"itemListElement\" itemscope itemtype=\"https://schema.org/ListItem\">\n      <a itemprop=\"item\" href=\"/docs/tutorials/\">\n        <span itemprop=\"name\">Tutorials</span>\n      </a>\n      <meta itemprop=\"position\" content=\"2\" />\n    </li>\n    <li itemprop=\"itemListElement\" itemscope itemtype=\"https://schema.org/ListItem\">\n      <a itemprop=\"item\" href=\"/docs/tutorials/getting-started/\">\n        <span itemprop=\"name\">Getting Started</span>\n      </a>\n      <meta itemprop=\"position\" content=\"3\" />\n    </li>\n    <li itemprop=\"itemListElement\" itemscope itemtype=\"https://schema.org/ListItem\">\n      <span itemprop=\"name\"><strong>Installation</strong></span>\n      <meta itemprop=\"position\" content=\"4\" />\n    </li>\n  </ol>\n</nav>\n```\n\n---\n\n## 6. Cross-Reference Strategy\n\n### 6.1 Cross-Reference Types\n\n| Type | Purpose | Example |\n|------|---------|---------|\n| **Prerequisites** | Link to required prior reading | \"Before starting, complete [Installation](../getting-started/installation.md)\" |\n| **Related Concepts** | Connect to explanations | \"Learn more about [Event Sourcing](../explanation/core-concepts/event-sourcing.md)\" |\n| **Next Steps** | Guide progression | \"Ready for more? Try [Building a Todo API](./todo-api.md)\" |\n| **See Also** | Related topics | \"See also: [Quality Convergence](../explanation/core-concepts/quality-convergence.md)\" |\n| **Reference Links** | Technical details | \"For all options, see [CLI Reference](../reference/cli/run-create.md)\" |\n| **Troubleshooting** | Problem resolution | \"Having issues? Check [Troubleshooting](../how-to/troubleshooting/)\" |\n\n### 6.2 Cross-Reference Placement Strategy\n\n#### In Tutorials\n\n| Location | Cross-Reference Type |\n|----------|---------------------|\n| Introduction | Prerequisites |\n| Concept mentions | Related Concepts |\n| Command usage | Reference Links |\n| End of page | Next Steps, See Also |\n| Error scenarios | Troubleshooting |\n\n#### In How-to Guides\n\n| Location | Cross-Reference Type |\n|----------|---------------------|\n| Introduction | Prerequisites, Related Concepts |\n| Step details | Reference Links |\n| Advanced options | See Also |\n| End of page | Related How-tos, Troubleshooting |\n\n#### In Reference\n\n| Location | Cross-Reference Type |\n|----------|---------------------|\n| Overview | Tutorials for usage examples |\n| Related items | Other Reference pages |\n| Complex concepts | Explanation pages |\n\n#### In Explanation\n\n| Location | Cross-Reference Type |\n|----------|---------------------|\n| Practical applications | How-to Guides |\n| Technical details | Reference pages |\n| Learning paths | Tutorials |\n| Related concepts | Other Explanation pages |\n\n### 6.3 Cross-Reference Matrix\n\nThis matrix shows primary relationships between sections:\n\n| From \\ To | Tutorials | How-to | Reference | Explanation |\n|-----------|-----------|--------|-----------|-------------|\n| **Tutorials** | Next steps | After completion | Commands used | Background |\n| **How-to** | Prerequisites | Related tasks | Technical details | Why this matters |\n| **Reference** | Usage examples | Practical application | Related items | Concepts |\n| **Explanation** | Try it yourself | Apply this | Technical spec | Related topics |\n\n### 6.4 Internal Linking Patterns\n\n#### Pattern 1: Inline Contextual Link\n```markdown\nThe [journal system](../explanation/architecture/journal-system.md) stores all events\nas append-only records.\n```\n\n#### Pattern 2: Callout Box\n```markdown\n> **Learn More**\n>\n> To understand why Babysitter uses event sourcing, see\n> [Event Sourcing Explained](../explanation/core-concepts/event-sourcing.md).\n```\n\n#### Pattern 3: Prerequisites Block\n```markdown\n## Prerequisites\n\nBefore starting this tutorial, ensure you have:\n- Completed [Installation](./installation.md)\n- Read [Your First Run](./your-first-run.md)\n- Basic understanding of [TDD concepts](../explanation/methodologies/tdd-philosophy.md)\n```\n\n#### Pattern 4: Next Steps Section\n```markdown\n## Next Steps\n\nNow that you've completed your first run:\n- **Continue learning:** [Understanding Results](./understanding-results.md)\n- **Build something:** [TDD Calculator Tutorial](../building-features/tdd-calculator.md)\n- **Go deeper:** [Event Sourcing Explained](../explanation/core-concepts/event-sourcing.md)\n```\n\n#### Pattern 5: See Also Footer\n```markdown\n---\n\n## See Also\n\n- [Quality Convergence](../explanation/core-concepts/quality-convergence.md) - Understand how quality targets work\n- [Set Quality Targets](../how-to/quality/set-quality-targets.md) - Configure targets for your projects\n- [Debug Quality Issues](../how-to/troubleshooting/debug-quality-issues.md) - When quality doesn't converge\n```\n\n### 6.5 External Link Strategy\n\n| External Resource | Link Pattern | Notes |\n|-------------------|--------------|-------|\n| Claude Code Docs | Link with icon | Opens new tab |\n| GitHub Repository | Direct link | For code references |\n| npm Packages | npm badge + link | Version info |\n| Community Resources | Dedicated section | Slack, Discord, etc. |\n\n---\n\n## 7. Content Templates\n\n### 7.1 Tutorial Template\n\n```markdown\n---\ntitle: [Tutorial Title]\ndescription: [One-sentence description]\ncategory: tutorial\nlevel: beginner | intermediate | advanced\nestimated_time: [X minutes]\nprerequisites:\n  - [list of prerequisite pages]\npersonas:\n  - [primary personas]\n---\n\n# [Tutorial Title]\n\n**Time:** [X minutes] | **Level:** [Beginner/Intermediate/Advanced]\n\n## What You'll Learn\n\nBy the end of this tutorial, you will be able to:\n- [Learning objective 1]\n- [Learning objective 2]\n- [Learning objective 3]\n\n## Prerequisites\n\nBefore starting, ensure you have:\n- [ ] [Prerequisite 1 with link]\n- [ ] [Prerequisite 2 with link]\n\n## What We're Building\n\n[Brief description of the project/outcome, with screenshot or diagram if applicable]\n\n---\n\n## Step 1: [Action Title]\n\n[Explanation of what we're doing and why]\n\n```bash\n[command]\n```\n\n**What you should see:**\n\n```\n[expected output]\n```\n\n> **Note:** [Helpful tip or common mistake to avoid]\n\n---\n\n## Step 2: [Action Title]\n\n[Continue pattern...]\n\n---\n\n## Step [N]: [Final Action]\n\n[Final step...]\n\n---\n\n## Summary\n\nYou've successfully:\n- [Accomplishment 1]\n- [Accomplishment 2]\n- [Accomplishment 3]\n\n## Next Steps\n\n- **Continue learning:** [Next tutorial link]\n- **Apply this:** [Related how-to link]\n- **Go deeper:** [Related explanation link]\n\n## Troubleshooting\n\n### [Common Issue 1]\n\n**Symptom:** [What the user sees]\n\n**Solution:** [How to fix it]\n\n### [Common Issue 2]\n\n[Continue pattern...]\n\n---\n\n## See Also\n\n- [Related page 1]\n- [Related page 2]\n```\n\n### 7.2 How-to Guide Template\n\n```markdown\n---\ntitle: How to [Task]\ndescription: [One-sentence description of what this achieves]\ncategory: how-to\nsection: [workflows|quality|breakpoints|integration|methodologies|troubleshooting|customization]\npersonas:\n  - [primary personas]\n---\n\n# How to [Task]\n\n[One paragraph explaining what this guide helps you accomplish and when you'd need it]\n\n## Prerequisites\n\n- [Prerequisite 1]\n- [Prerequisite 2]\n\n## Steps\n\n### 1. [First Action]\n\n[Brief explanation]\n\n```bash\n[command or code]\n```\n\n### 2. [Second Action]\n\n[Brief explanation]\n\n```bash\n[command or code]\n```\n\n### 3. [Continue as needed...]\n\n---\n\n## Variations\n\n### [Variation 1: Different Scenario]\n\n[Adjusted steps for this scenario]\n\n### [Variation 2: Alternative Approach]\n\n[Adjusted steps for this approach]\n\n---\n\n## Verification\n\nTo confirm success:\n\n```bash\n[verification command]\n```\n\nExpected result: [what indicates success]\n\n---\n\n## Common Issues\n\n| Issue | Cause | Solution |\n|-------|-------|----------|\n| [Issue 1] | [Cause] | [Solution] |\n| [Issue 2] | [Cause] | [Solution] |\n\n---\n\n## Related Guides\n\n- [Related how-to 1]\n- [Related how-to 2]\n\n## Reference\n\n- [CLI command reference]\n- [Configuration reference]\n```\n\n### 7.3 Reference Template\n\n```markdown\n---\ntitle: [Reference Item Name]\ndescription: [Brief technical description]\ncategory: reference\nsection: [cli|api|configuration|file-structure]\n---\n\n# [Reference Item Name]\n\n[One-paragraph technical description]\n\n## Synopsis\n\n```\n[command syntax or API signature]\n```\n\n## [Options/Parameters/Properties]\n\n| Name | Type | Required | Default | Description |\n|------|------|----------|---------|-------------|\n| `[name]` | [type] | [Yes/No] | [default] | [Description] |\n| `[name]` | [type] | [Yes/No] | [default] | [Description] |\n\n## [Return Value/Output]\n\n[Description of what is returned or output]\n\n### [Format 1: JSON]\n\n```json\n{\n  \"[field]\": \"[description]\"\n}\n```\n\n### [Format 2: Text]\n\n```\n[text output format]\n```\n\n## Examples\n\n### Basic Usage\n\n```bash\n[example command]\n```\n\nOutput:\n```\n[example output]\n```\n\n### [Specific Use Case]\n\n```bash\n[example command for use case]\n```\n\n## [Exit Codes / Error Handling]\n\n| Code | Meaning |\n|------|---------|\n| [code] | [meaning] |\n\n## [Related / See Also]\n\n- [Related reference 1]\n- [Related reference 2]\n- [How-to guide using this]\n```\n\n### 7.4 Explanation Template\n\n```markdown\n---\ntitle: [Concept Name]\ndescription: [One-sentence description]\ncategory: explanation\nsection: [core-concepts|architecture|methodologies|governance|best-practices]\npersonas:\n  - [primary personas]\n---\n\n# [Concept Name]\n\n[Opening paragraph that establishes context and importance]\n\n## Overview\n\n[High-level explanation accessible to all readers]\n\n## [Core Concept Section 1]\n\n[Detailed explanation with examples]\n\n### [Subsection if needed]\n\n[Further detail]\n\n## [Core Concept Section 2]\n\n[Continue pattern...]\n\n## How It Works\n\n[Technical explanation with diagrams if helpful]\n\n```\n[diagram in ASCII or reference to image]\n```\n\n## Why This Matters\n\n[Explanation of importance and benefits]\n\n### [Benefit 1]\n\n[Explanation]\n\n### [Benefit 2]\n\n[Explanation]\n\n## Trade-offs and Alternatives\n\n[Discussion of trade-offs, when this approach isn't ideal, alternatives]\n\n| Approach | Pros | Cons |\n|----------|------|------|\n| [Approach 1] | [Pros] | [Cons] |\n| [Approach 2] | [Pros] | [Cons] |\n\n## Practical Applications\n\n[How to apply this understanding]\n\n- **[Scenario 1]:** [Application]\n- **[Scenario 2]:** [Application]\n\n## Further Reading\n\n- [Internal link to related explanation]\n- [Internal link to how-to guide]\n- [External resource if appropriate]\n\n---\n\n## Summary\n\n[Key takeaways in 2-3 sentences]\n```\n\n### 7.5 Glossary Entry Template\n\n```markdown\n### [Term]\n\n**Definition:** [Clear, concise definition in one sentence]\n\n**Context:** [Where/how this term is used in Babysitter]\n\n**Example:** [Brief example of usage]\n\n**Related Terms:** [Link to related glossary entries]\n\n**Learn More:** [Link to explanation page if available]\n```\n\n### 7.6 Error Catalog Entry Template\n\n```markdown\n### [Error Code/Message]\n\n**Error Message:**\n```\n[Exact error message text]\n```\n\n**Cause:** [What causes this error]\n\n**Solution:**\n1. [Step 1]\n2. [Step 2]\n\n**Prevention:** [How to avoid this error]\n\n**Related:** [Link to relevant documentation]\n```\n\n---\n\n## 8. Implementation Guidelines\n\n### 8.1 File Naming Conventions\n\n| Rule | Example |\n|------|---------|\n| Lowercase only | `your-first-run.md` |\n| Hyphens for spaces | `github-actions.md` |\n| No special characters | `run-create.md` not `run:create.md` |\n| Descriptive names | `configure-breakpoint-service.md` |\n| Index files for sections | `index.md` |\n\n### 8.2 Frontmatter Standards\n\nEvery documentation file must include:\n\n```yaml\n---\ntitle: [Page Title]                    # Required\ndescription: [SEO description]          # Required, max 160 chars\ncategory: [tutorial|how-to|reference|explanation]  # Required\nlevel: [beginner|intermediate|advanced] # Required for tutorials\nsection: [section-name]                 # Required for how-to and reference\nestimated_time: [X minutes]             # Required for tutorials\nprerequisites:                          # Recommended\n  - [prerequisite-slug]\npersonas:                               # Recommended\n  - sarah-chen\n  - james-park\nlast_updated: [YYYY-MM-DD]             # Required\n---\n```\n\n### 8.3 Content Quality Checklist\n\nBefore publishing any documentation page:\n\n- [ ] **Frontmatter complete** with all required fields\n- [ ] **Breadcrumbs verified** against hierarchy\n- [ ] **Cross-references working** (all internal links tested)\n- [ ] **Code examples tested** and working\n- [ ] **Screenshots current** (if applicable)\n- [ ] **Spelling and grammar** reviewed\n- [ ] **Persona alignment** verified (content matches target personas)\n- [ ] **Prerequisites accurate** and linked\n- [ ] **Next steps included** for progression\n\n### 8.4 URL Structure\n\nBase URL: `https://docs.babysitter.dev/`\n\n| Pattern | Example URL |\n|---------|-------------|\n| Tutorial | `/tutorials/getting-started/installation/` |\n| How-to | `/how-to/breakpoints/configure-service/` |\n| Reference | `/reference/cli/run-create/` |\n| Explanation | `/explanation/core-concepts/event-sourcing/` |\n\n### 8.5 Search Optimization\n\n#### Page Metadata\n\n- Title: Include primary keyword, max 60 characters\n- Description: Actionable summary, max 160 characters\n- Headers: Use H1 for title, H2 for sections, H3 for subsections\n\n#### Content Optimization\n\n- Primary keyword in first 100 words\n- Related keywords naturally distributed\n- Internal links with descriptive anchor text\n- Alt text for all images\n\n#### Structured Data\n\nImplement JSON-LD for:\n- BreadcrumbList (all pages)\n- HowTo (how-to guides)\n- TechArticle (reference pages)\n- FAQPage (troubleshooting pages)\n\n### 8.6 Accessibility Requirements\n\n- **Heading hierarchy:** Sequential (H1 > H2 > H3), no skipped levels\n- **Link text:** Descriptive, not \"click here\"\n- **Images:** Alt text for all images\n- **Code blocks:** Language specified for syntax highlighting\n- **Tables:** Header rows defined\n- **Color:** Never sole means of conveying information\n- **Keyboard navigation:** All interactive elements accessible\n\n### 8.7 Versioning Strategy\n\n| Content Type | Versioning Approach |\n|--------------|---------------------|\n| Tutorials | Single version, updated with each release |\n| How-to Guides | Single version with version callouts |\n| Reference | Multi-version with version selector |\n| Explanation | Single version, concepts rarely change |\n\nVersion callout format:\n```markdown\n> **Version Note:** This feature requires Babysitter v1.2.0 or later.\n```\n\n### 8.8 Maintenance Schedule\n\n| Task | Frequency | Owner |\n|------|-----------|-------|\n| Link validation | Weekly (automated) | CI/CD |\n| Code example testing | Per release | Release engineer |\n| Screenshot updates | Per major release | Documentation team |\n| Content review | Quarterly | Documentation team |\n| Analytics review | Monthly | Documentation lead |\n| User feedback review | Weekly | Documentation team |\n\n---\n\n## Appendix A: Persona-to-Content Mapping\n\n### Sarah Chen (Productivity-Focused Developer)\n\n| Priority | Content Path |\n|----------|--------------|\n| P0 | Tutorials > Getting Started > * |\n| P0 | How-to > Methodologies > * |\n| P0 | Reference > CLI > (quick reference) |\n| P1 | How-to > Workflows > * |\n| P1 | How-to > Quality > * |\n| P2 | Explanation > Methodologies > methodology-comparison |\n\n### Marcus Thompson (Technical Lead)\n\n| Priority | Content Path |\n|----------|--------------|\n| P0 | Explanation > Architecture > * |\n| P0 | Explanation > Governance > * |\n| P0 | How-to > Breakpoints > * |\n| P1 | Explanation > Best Practices > team-adoption |\n| P1 | How-to > Customization > * |\n| P2 | Tutorials > Advanced Projects > team-onboarding |\n\n### Elena Rodriguez (DevOps Engineer)\n\n| Priority | Content Path |\n|----------|--------------|\n| P0 | Reference > CLI > * |\n| P0 | How-to > Integration > * |\n| P0 | Reference > Configuration > * |\n| P1 | Explanation > Architecture > * |\n| P1 | How-to > Customization > * |\n| P2 | Tutorials > Advanced Projects > ci-integration-tutorial |\n\n### James Park (Curious Newcomer)\n\n| Priority | Content Path |\n|----------|--------------|\n| P0 | Explanation > Core Concepts > what-is-babysitter |\n| P0 | Tutorials > Getting Started > * (all, in order) |\n| P0 | Reference > Glossary |\n| P1 | Explanation > Core Concepts > * |\n| P1 | Tutorials > Building Features > tdd-calculator |\n| P2 | How-to > Troubleshooting > installation-issues |\n\n---\n\n## Appendix B: Implementation Phases\n\n### Phase 1: Foundation (Weeks 1-2)\n\n**Focus:** Beginner onboarding and core reference\n\n| Deliverable | Category | Priority |\n|-------------|----------|----------|\n| What is Babysitter? | Explanation | P0 |\n| Prerequisites | Tutorial | P0 |\n| Installation | Tutorial | P0 |\n| Your First Run | Tutorial | P0 |\n| Glossary | Reference | P0 |\n| CLI Overview | Reference | P0 |\n\n### Phase 2: Core Workflows (Weeks 3-4)\n\n**Focus:** Daily use documentation\n\n| Deliverable | Category | Priority |\n|-------------|----------|----------|\n| TDD Calculator Tutorial | Tutorial | P1 |\n| Resume Interrupted Work | How-to | P1 |\n| Set Quality Targets | How-to | P1 |\n| Configure Breakpoint Service | How-to | P1 |\n| run:create Reference | Reference | P1 |\n| run:iterate Reference | Reference | P1 |\n| Event Sourcing | Explanation | P1 |\n\n### Phase 3: Integration (Weeks 5-6)\n\n**Focus:** CI/CD and automation\n\n| Deliverable | Category | Priority |\n|-------------|----------|----------|\n| GitHub Actions | How-to | P1 |\n| GitLab CI | How-to | P2 |\n| Scripting with CLI | How-to | P1 |\n| Exit Codes Reference | Reference | P1 |\n| Environment Variables | Reference | P1 |\n| Deterministic Execution | Explanation | P2 |\n\n### Phase 4: Advanced (Weeks 7-8)\n\n**Focus:** Customization and governance\n\n| Deliverable | Category | Priority |\n|-------------|----------|----------|\n| Create Custom Process | How-to | P2 |\n| CI Integration Tutorial | Tutorial | P2 |\n| Architecture Overview | Explanation | P2 |\n| Audit Trails | Explanation | P2 |\n| Security Model | Explanation | P2 |\n| Team Adoption | Explanation | P2 |\n\n---\n\n**Document Status:** Complete\n**Next Phase:** Begin content creation following Phase 1 deliverables\n**Review Date:** 2026-02-01\n",
    "documents": []
  },
  "outgoingEdges": [],
  "incomingEdges": [
    {
      "from": "page:docs-user-guide",
      "to": "page:docs-user-guide-03-information-architecture",
      "kind": "contains_page"
    }
  ]
}

Shortcuts

Back to overview
Open graph tab