Agent skill

Documentation Structure

by miroapp in miroapp/miro-ai

Documentation architecture for this repository. An agent skill from miroapp/miro-ai.

MITAuto-check passedDevelopment

Install Documentation Structure

skills CLI
$ npx skills add miroapp/miro-ai --skill documentation-structure -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install miroapp/miro-ai documentation-structure --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/miroapp/miro-ai.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.agents/skills/documentation-structure .claude/skills/documentation-structure && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
documentation-structure
GitHub stars
160
Token cost
~1.3k tokens
SKILL.md length
420 words
Files
2 (incl. references)
Skills in repo
5
Repo updated
First seen
Licence
MIT

At a glance

Documentation architecture for this repository. An agent skill from miroapp/miro-ai.

  • Reviewing README.md
  • SKILL.md covers Core Principles, Document Responsibilities, User vs Developer Content… and Vendor Documentation Standards, plus 3 more sections
  • Reaches developers.miro.com
  • CONTRIBUTING.md

What it does

Documentation Structure is an agent skill from miroapp/miro-ai. Documentation architecture for this repository. Use when creating, updating, or reviewing README.md, CONTRIBUTING.md, or docs/ files. Covers separation of concerns, vendor documentation standards, cross-references, and validation.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. The skill folder holds 2 other files, including reference files (for example `references/patterns.md`).

It sits in Development, covering Technical documentation. The repository describes itself as: Official Miro AI developer tools and integrations. Includes MCP server configuration, Claude Code skills, and resources for building AI-powered experiences with Miro boards. The licence is MIT.

When your agent uses it

  • Reviewing README.md
  • CONTRIBUTING.md

Example prompts

  • “/documentation-structure”

What it can do on your machine

Read from SKILL.md and the folder at commit b6408e1. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md (its code samples are markdown).

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Hosts in commands or code, which the agent is likely to contact:

    • developers.miro.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Documentation Structure loads about 1.3k tokens when it runs, and up to ~2.3k if it reads all its reference files. Until then it costs about 64 tokens; SKILL.md has 420 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~64
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k
With references · SKILL.md plus every file in references/, read only if the agent opens them
~2.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from miroapp/miro-ai at commit b6408e1, republished under its MIT licence (© miroapp). 420 words, ~1,276 tokens.

Download SKILL.mdSave it as .claude/skills/documentation-structure/SKILL.md (or your agent's skills folder). This skill also uses 1 other file; get the full folder from GitHub.
name
documentation-structure
description
Documentation architecture for this repository. Use when creating, updating, or reviewing README.md, CONTRIBUTING.md, or docs/ files. Covers separation of concerns, vendor documentation standards, cross-references, and validation.

Documentation Structure

This skill defines how documentation is organized and maintained in this repository.

Core Principles

PrincipleDescription
Separation of ConcernsREADME (landing), docs/ (reference), CONTRIBUTING (dev workflow)
Single Source of TruthDefine once, link everywhere. Never duplicate content.
Hub-and-Spokedocs/README.md is the central navigation hub
Vendor IsolationEach AI platform gets its own directory in docs/

Document Responsibilities

User vs Developer Content Separation

CRITICAL RULE: User documentation must ONLY contain fully automated installation methods. All manual setup belongs in developer documentation.

Content TypeUser DocsDeveloper Docs
Marketplace install✓✓
One-command GitHub install✓✓
git clone✗✓
--plugin-dir✗✓
extensions link✗✓
JSON config editing✗✓
Local path setup✗✓
mcp_settings.json✗✓
User Documentation (README.md, docs/*/overview.md)
  • Installation must be copy-paste simple
  • Single command or UI-only steps
  • Link to dev docs for manual alternatives
Developer Documentation (CONTRIBUTING.md, docs//-development.md)
  • All manual setup workflows
  • Local testing procedures
  • Configuration file editing
  • Environment setup
README.md (Landing Page)

Purpose: First impression. Get users started quickly.

Must include:

  • One-line description
  • Quick Start (4 steps: Choose → Install → Authenticate → Try)
  • Capability tables (what users can do)
  • Links to docs/ for details

Must NOT include:

  • Full API reference (→ docs/mcp/)
  • Development workflows (→ CONTRIBUTING.md)
  • Detailed architecture (→ docs/)
docs/ (Reference Documentation)

Purpose: Complete reference for users and developers.

Structure:

docs/
├── README.md              # Navigation hub
├── troubleshooting.md     # Cross-platform issues
├── getting-started/       # Entry points
│   ├── mcp-setup.md       # Generic MCP config
│   └── enterprise.md      # Admin requirements
├── claude-code/           # Vendor: Claude Code
├── kiro/                  # Vendor: Kiro
├── gemini-cli/            # Vendor: Gemini CLI
└── mcp/                   # Protocol reference
    ├── tools-reference.md
    └── tutorials.md
CONTRIBUTING.md (Development Workflow)

Purpose: How to modify THIS repository.

Must include:

  • Clone and local dev setup
  • How to test changes locally (--plugin-dir, etc.)
  • Validation checklists
  • PR process

Must NOT include:

  • Full plugin/power architecture (→ docs/)
  • User-facing tutorials (→ docs/)

Vendor Documentation Standards

Each vendor directory in docs/ follows this pattern:

Show full SKILL.md (173 more words)Show less
Required Files
FilePurpose
overview.mdWhat is this integration, why use it, installation
*-development.mdHow to build new plugins/powers/extensions
Individual component docsOne file per plugin/power
Standard Sections in overview.md
markdown
## What are [Plugins/Powers/Extensions]?
## Why Use [Plugins/Powers] vs Direct MCP?
## Available [Plugins/Powers]
## Installation
## Authentication
## Related
Vendor-Specific Metadata
VendorConfig FormatLocation
Claude Codeplugin.json.claude-plugin/plugin.json
KiroPOWER.md frontmatterPOWER.md
Gemini CLIJSON extensiongemini-extension.json

Cross-Reference Patterns

  • Within docs/: Use relative paths [text](../mcp/tools-reference.md)
  • From README to docs/: Use docs/ prefix [text](docs/claude-code/overview.md)
  • External links: Full URLs [text](https://developers.miro.com)

Every doc file should end with a Related section:

markdown
## Related

- [Overview](overview.md) - Introduction to this integration
- [Tools Reference](../mcp/tools-reference.md) - MCP tool documentation

If doc A links to doc B, doc B should link back to doc A in its Related section.

Validation Guidelines

Before committing documentation changes:

Content Checks
  • No duplicated content (link instead)
  • Correct document owns the content (README vs docs/ vs CONTRIBUTING)
  • All sections present per vendor standards
  • All internal links resolve
  • Related sections have reciprocal links
  • External links use HTTPS
Format Checks
  • Code blocks have language specified
  • Tables have consistent formatting
  • Collapsibles have matching tags

See Also

  • references/patterns.md - Formatting patterns (tables, collapsibles, code blocks)

© miroapp, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 1 other file (references) in .agents/skills/documentation-structure of miroapp/miro-ai.

  • SKILL.md
  • references/patterns.md

Open the folder on GitHubat commit b6408e1

Compare with similar skills

Documentation Structure next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Documentation Structure compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Documentation Structure this skillmiroapp/miro-ai160—~1.3kAutomated safety check: PassMIT
Diagram Designcathrynlavery/diagram-design45k1 repos~7.5kAutomated safety check: PassMIT
Simple Englishmoeru-ai/airi50k2 repos~4.6kAutomated safety check: PassMIT
Get API Docs with chubandrewyng/context-hub14k2 repos~775Automated safety check: PassMIT
Doc SyncJetBrains/ideavim10k2 repos~2.6kAutomated safety check: PassMIT
Mailspring App ScreenshotsFoundry376/Mailspring18k—~1.5kAutomated safety check: PassGPL-3.0

Similar skills

  • Diagram Design

    cathrynlavery/diagram-design

    Creates branded diagrams, from architecture, flowchart and sequence to charts and maps, as self-contained HTML with inline SVG, with import from draw.io, Mermaid and Excalidraw.

    45k GitHub starsUsed in 1 repo~7.5k tokens
    DevelopmentAuto-check passed
  • Simple English

    moeru-ai/airi

    Write or rewrite technical text with the rules of ASD-STE100 Simplified Technical English so it is clear, unambiguous, and free of AI slop.

    50k GitHub starsUsed in 2 repos~4.6k tokens
    DevelopmentAuto-check passed
  • Get API Docs with chub

    andrewyng/context-hub

    Fetches current documentation for third-party APIs and SDKs with the chub CLI before the agent writes code against them, instead of relying on remembered API shapes.

    14k GitHub starsUsed in 2 repos~775 tokens
    DevelopmentAuto-check passed
  • Doc Sync

    JetBrains/ideavim

    Official

    Keeps IdeaVim documentation in sync with code changes. An agent skill from JetBrains/ideavim.

    10k GitHub starsUsed in 2 repos~2.6k tokens
    DevelopmentAuto-check passed
  • Mailspring App Screenshots

    Foundry376/Mailspring

    Captures screenshots of the running Mailspring dev app for docs, PRs or visual checks by launching it with a debugging port, driving the UI and clipping to an element.

    18k GitHub stars~1.5k tokensUpdated today
    DevelopmentAuto-check passed
  • Draw.io Diagram Studio

    Agents365-ai/drawio-skill

    Creates and edits editable draw.io diagrams from descriptions, code, infrastructure files, SQL and API schemas, with sync, review, test and export tools.

    10k GitHub stars~2.4k tokensUpdated 5 days ago
    DevelopmentAuto-check: notes

More from miroapp/miro-ai

  • Miro Code Spec

    miroapp/miro-ai

    A skill your agent uses when the user wants to extract a Miro board's specs (documents, diagrams, prototypes, tables, frames, images) to local .miro/specs/ files for AI-assisted planning and…

    160 GitHub stars~4.7k tokensUpdated 20 days ago
    Auto-check passed
  • A skill your agent uses when the user wants to explain or visualize a codebase on a Miro board — produces a minimal, notation-correct set of architecture / structure / behavior diagrams (flowchart…

    160 GitHub stars~2.4k tokensUpdated 20 days ago
    Auto-check passed
  • Miro Code Review

    miroapp/miro-ai

    A skill your agent uses when the user wants to create a visual code review on a Miro board from a pull/merge request (GitHub, GitLab, or any forge), local uncommitted changes, or a branch comparison…

    160 GitHub stars~4.8k tokensUpdated 20 days ago
    Auto-check: warnings
  • Skills Development

    miroapp/miro-ai

    A skill your agent uses when authoring or revising plugin SKILL.md files in this repo.

    160 GitHub stars~238 tokensUpdated 20 days ago
    Auto-check passed

Categories

Questions about Documentation Structure

What does Documentation Structure do?

Documentation architecture for this repository. An agent skill from miroapp/miro-ai. Documentation Structure is an agent skill from miroapp/miro-ai. Documentation architecture for this repository.

When should I use Documentation Structure?

Documentation Structure fits situations like: reviewing README.md; CONTRIBUTING.md.

How do I install Documentation Structure in Claude Code?

Run `npx skills add miroapp/miro-ai --skill documentation-structure -a claude-code`. Or copy the skill folder (.agents/skills/documentation-structure in miroapp/miro-ai) into .claude/skills/documentation-structure in your project. Claude Code loads it when a task matches its description.

How do I install Documentation Structure in Codex?

Run `npx skills add miroapp/miro-ai --skill documentation-structure -a codex`. Or copy the skill folder (.agents/skills/documentation-structure in miroapp/miro-ai) into .agents/skills/documentation-structure in your project. Codex loads it when a task matches its description.

Can I use Documentation Structure in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add miroapp/miro-ai --skill documentation-structure -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/documentation-structure, .gemini/skills/documentation-structure, .github/skills/documentation-structure and .opencode/skills/documentation-structure in your project.

What does Documentation Structure need to run?

SKILL.md names no scripts, command-line tools or credentials: Documentation Structure is instructions for the agent only.

Does Documentation Structure access the network?

SKILL.md names 1 domain. In commands or code: developers.miro.com; the agent is likely to contact it when it follows the instructions. This is read from the text; nothing was executed.

Is Documentation Structure safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Documentation Structure use?

Documentation Structure is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Documentation Structure use?

About 1.3k tokens (SKILL.md is roughly 5.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 1k tokens, read only when the agent opens those files.

What are the alternatives to Documentation Structure?

Skills that share tags, products or a category with Documentation Structure: Diagram Design (cathrynlavery/diagram-design, 45k stars), Simple English (moeru-ai/airi, 50k stars), Get API Docs with chub (andrewyng/context-hub, 14k stars) and Doc Sync (JetBrains/ideavim, 10k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Documentation Structure?

miroapp (a GitHub organization) maintains it in miroapp/miro-ai, which has 160 GitHub stars. The repository holds 5 skills in this directory. The repository was last updated on September 17, 2026.

Source: miroapp/miro-ai on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.