Skip to content
Beta Multi-model support (OpenAI, Gemini, and more) launching soon.
RBA RBA Skills

documentation-generator

v0.1.0 ExperimentalNo security review by Dakota Smith

Install

Pick the surface you use. Plugins run inside Claude Code, which is available in the terminal CLI, the desktop app on Mac and Windows, the web app at claude.ai/code, and the VS Code and JetBrains extensions. The slash commands are identical on every surface.

From inside any Claude Code session — terminal, desktop app, web app, or IDE extension:

  1. Add the RBA Skills marketplace (only needed once per machine):

    /plugin marketplace add rbaconsulting/rba-skills-plugin

  2. Install documentation-generator:

    /plugin install documentation-generator@rba-ai-hub

  3. Activate it without restarting:

    /reload-plugins

Overview

Documentation Generator

RBA Consulting's documentation toolkit for digital experience projects. This plugin generates, updates, and audits the full documentation surface for a DXP engagement — from first solution design through to live operational runbooks — by reading repo context, IaC files, and project tickets rather than asking you to describe the system from memory.

What's inside

Artifact Purpose
solution-design-doc skill Generates a complete Solution Design Document (SDD) for a DXP feature or integration from code, tickets, and architecture notes. Produces a structured Markdown deliverable ready for client review or internal governance.
adr-writer skill Authors immutable Architecture Decision Records following the MADR (Markdown Architectural Decision Records) format. Captures context, considered options with pros/cons, decision, and consequences. Handles superseding previous ADRs.
runbook-generator skill Produces operational runbooks for any platform service (Azure App Service, Sitecore XM Cloud, Umbraco Cloud, Optimizely CMS, Azure Container Apps). Includes topology diagrams, SOPs, incident playbooks, KQL queries, and rollback procedures.
onboarding-guide skill Generates a developer or content-editor onboarding guide for an existing project by reading the repo structure, stack, CI/CD pipelines, and access patterns. Reduces ramp-up time for new joiners and client hand-offs.
diagram-suite skill Generates C4 Context + Container diagrams, sequence diagrams, and MACH-layer architecture diagrams using Mermaid. Platform-agnostic with named adapter sections for Sitecore, Optimizely, Umbraco, Azure, and composable/MACH stacks.
living-docs-sync skill Audits existing documentation for staleness relative to current code and tickets, then updates or flags sections that are out of date. Designed for weekly or sprint-end doc maintenance.
doc-reviewer agent Subagent that validates a documentation PR or a generated doc against RBA's documentation standards: completeness, accuracy, cross-reference consistency, and least-privilege tool usage.
/generate-docs command Guided entry-point slash command: asks what you need (SDD, ADR, runbook, onboarding, diagrams) and dispatches to the right skill with the right context.

When to use

  • Build phase — after a sprint produces new features or integrations, generate or update the SDD and any affected ADRs before review gates
  • Pre-go-live — generate runbooks for each environment tier (dev, staging, prod) before handover to the support team or the client
  • Project kick-off — generate a scaffold onboarding guide the moment the repo and CI/CD are in place, so it stays current from day one
  • Architecture reviews — produce a fresh diagram suite and a set of ADRs to take into governance meetings
  • Client handover — run living-docs-sync to bring all docs up to date before handing the platform to the client's internal team
  • Sprint ceremonies — run adr-writer whenever the team makes a significant technical decision that should be recorded for future reference

Platform adapters

All skills generate platform-agnostic documentation with named adapter sections for:

  • Sitecore XM Cloud — Headless SaaS CMS; pages reference Sitecore Layout Service, Sitecore Edge, and CDP/Personalize patterns
  • Optimizely CMS — Content Graph, A/B experimentation, commerce; docs include Graph endpoint references and CMS SaaS considerations
  • Umbraco Cloud / Umbraco 13 — .NET open-source; docs reference the Delivery API, Umbraco Cloud environments, and Deploy pipeline
  • Azure — The RBA default cloud; runbooks default to Azure App Service, Azure Front Door, Azure Key Vault, Azure Monitor, and Azure DevOps
  • MACH composable stacks — Any combination of best-of-breed services; diagrams and SOPs adapt to the services in scope

How to install

claude plugin install documentation-generator@rba-ai-hub

After installation, use the guided entry point:

/generate-docs

Or invoke any skill directly:

/solution-design-doc "PROJ-123 search integration with Coveo"
/adr-writer "use Azure Service Bus instead of direct webhooks for content publish events"
/runbook-generator "production environment for Umbraco 13 on Azure App Service"
/onboarding-guide "developer onboarding for RBA ACME project"
/diagram-suite "Sitecore XM Cloud + Coveo + Dynamics 365 on Azure"
/living-docs-sync

Tools and permissions

These skills require read access to the repo and write access to produce Markdown deliverables. The runbook skill optionally queries the Azure CLI for live resource inventory. No secrets, no destructive operations, no credential directories are accessed.

Bundled artifacts

Skills

  • adr-writer — Authors an immutable Architecture Decision Record (ADR) following the MADR (Markdown Architectural Decision Records) format. Captures context, the decision drivers, all considered options with pros/cons, the decision, and its consequences. Handles superseding an existing ADR when the team changes course. Use whenever the team makes a significant technical decision — platform selection, integration pattern, auth scheme, infrastructure approach, coding standard, or any choice with lasting architectural consequences.
  • diagram-suite — Generates a suite of architecture diagrams — C4 Context, C4 Container, sequence diagrams, data-flow diagrams, and MACH-layer views — using Mermaid syntax. Reads the repo or a described stack to produce accurate, audience-calibrated diagrams for client presentations, ADRs, solution design documents, or governance reviews. Works with any composable DXP stack with named adapters for Sitecore XM Cloud, Optimizely, Umbraco, Azure, and MACH composable.
  • onboarding-guide — Generates a developer or content-editor onboarding guide for an existing DXP project by reading the repo structure, stack configuration, CI/CD pipelines, and access patterns. Produces a structured Markdown guide covering environment setup, architecture overview, contribution workflow, key contacts, and common tasks — so a new joiner or client team can be productive on day one. Use at project kick-off, before a new team member joins, or as part of a client handover package.
  • runbook-generator — Produces a complete operational runbook for any platform service or environment — including topology diagrams, access reference, standard operating procedures, incident playbooks with KQL queries, rollback procedures, and maintenance schedules. Reads repo IaC files and CI/CD pipelines to populate resource names and deployment steps accurately. Optionally queries the Azure CLI for live resource inventory. Use before go-live, during a managed-services onboarding, or when updating runbooks after infrastructure changes.
  • solution-design-doc — Generates a complete Solution Design Document (SDD) for a DXP feature, integration, or platform component by reading the repo, relevant tickets, and any existing architecture notes — rather than relying on the author's memory. Produces a structured, client-ready Markdown deliverable covering scope, architecture, data flows, component design, security, performance considerations, and open decisions. Use when beginning a significant feature, preparing for a design review, or documenting a completed sprint's technical decisions.
  • living-docs-sync — Audits existing documentation for staleness relative to current code, IaC, and recent git history, then updates or flags sections that are out of date. Detects documentation drift across READMEs, architecture docs, SDDs, runbooks, ADRs, and onboarding guides. Produces a staleness report and, where changes are unambiguous, applies in-place updates. Use at sprint end, before a release, or during a client handover to ensure docs reflect the current state of the platform.

Agents

  • doc-reviewer — Subagent that validates a generated or hand-authored documentation deliverable against RBA's documentation standards: structural completeness, factual accuracy relative to the codebase, cross-reference consistency, security hygiene (no secrets or credentials), and least-privilege tool usage. Invoke after any documentation skill run or directly on a documentation PR to get a structured pass/fail report before the doc goes to stakeholders.

Slash Commands

  • /generate-docs — Guided entry-point for the documentation-generator plugin. Asks what documentation you need, determines the right skill and context, then dispatches. Covers: solution design documents, ADRs, runbooks, onboarding guides, diagram suites, and living-docs audits.
Technical details
Homepage
https://rba-skills.tylerschroeder.net/plugins/documentation-generator/
License
MIT
Maturity
experimental
Security review
No security review
Owners
  • engineering
Disciplines
engineering, business-analysis
Lifecycle
build, operate
Tags
  • docs
  • adr
  • runbook
  • diagrams
  • solution-design
  • onboarding
  • living-docs
  • mermaid
  • c4
  • sitecore
  • umbraco
  • optimizely
  • azure
  • azure-devops
Last updated
by Tyler Schroeder
Source
plugins/documentation-generator/

Edit this plugin's README on GitHub — opens GitHub's web editor. No git knowledge needed.