playbooks

home / skills / greyhaven-ai / claude-code-config / documentation-architecture

documentation-architecture skill

/grey-haven-plugins/developer-experience/skills/documentation-architecture

This skill helps design scalable documentation architectures with automated generation, versioning, and search to streamline large-scale projects.

npx playbooks add skill greyhaven-ai/claude-code-config --skill documentation-architecture

Review the files below or copy the command above to add this skill to your agents.

Files (14)
SKILL.md
1.1 KB
---
name: grey-haven-documentation-architecture
description: "Comprehensive documentation systems design including structure, generation, maintenance, and automation. Use when designing documentation systems, automating documentation generation, or managing large-scale documentation projects."
# v2.0.43: Skills to auto-load for documentation work
skills:
  - grey-haven-code-style
  - grey-haven-project-structure
# v2.0.74: Tools for documentation architecture
allowed-tools:
  - Read
  - Write
  - Grep
  - Glob
  - TodoWrite
---

# Documentation Architecture Skill

Comprehensive documentation systems design including structure, generation, maintenance, and automation.

## Description

Design and maintain scalable documentation architectures with automated generation, versioning, and search.

## What's Included

- **Examples**: Documentation structures, automated generation
- **Reference**: Documentation best practices, architecture patterns
- **Templates**: Documentation templates, style guides

## Use When

- Designing documentation systems
- Automating documentation
- Large-scale doc projects

## Related Agents

- `docs-architect`

**Skill Version**: 1.0

Overview

This skill designs and maintains scalable documentation architectures focused on structure, automated generation, versioning, and search. It packages templates, examples, and best-practice patterns so teams can build consistent, maintainable doc systems for codebases and products.

How this skill works

The skill inspects documentation needs, proposes folder and metadata schemas, and generates pipelines for automated build and publishing. It includes templates for style guides, content structure, and CI automation to keep docs versioned, searchable, and up to date with code changes.

When to use it

  • Creating a new centralized documentation repository for multiple agents or services
  • Automating documentation generation from code, configs, and changelogs
  • Standardizing style, metadata, and structure across a large documentation corpus
  • Adding search, versioning, or release-aware publishing to existing docs
  • Planning maintenance workflows for ongoing doc ownership and reviews

Best practices

  • Define a clear content model: sections, metadata fields, and file naming conventions
  • Automate generation and publishing via CI pipelines to reduce manual drift
  • Version documentation alongside code to keep changes synchronized
  • Provide lightweight templates and style guides to speed authoring and enforce consistency
  • Integrate search and metadata indexing early to make content discoverable

Example use cases

  • Designing a documentation repository structure for an AI agent platform with shared components
  • Creating CI jobs that build docs from code comments, OpenAPI specs, and markdown sources
  • Rolling out a style guide and templates to unify contributions across distributed teams
  • Adding release-based doc branches and automated changelog inclusion for each deploy
  • Setting up a searchable index and tags so engineers can find agent commands and configs quickly

FAQ

How do I start when I have an existing messy docs repo?

Inventory content, map it to a target structure, migrate in phases, and add CI-driven builds to validate migration steps automatically.

Can this handle multi-version docs?

Yes. The architecture includes patterns for branching, versioned builds, and publishing versioned sites or namespaces for search.