documentation-structure

documentation-structure is a skill for Claude Code, Codex from miroapp/miro-ai. It costs 46 tokens per session (1,169 once invoked), scanned A, original, MIT.

A documentation-organization guide for README files, contribution instructions, and documentation folders in a code repository. It defines where different kinds of information belong and how documents should link to each other.

In plain words
What is it for?
Use it when creating, updating, or reviewing repository documentation, including README.md, CONTRIBUTING.md, and docs/ files.
Why use it?
It helps prevent duplicated, misplaced, or confusing documentation. It also separates instructions for users from manual setup information for developers.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/miroapp/miro-ai/documentation-structure
Any agent
npx skills add miroapp/miro-ai --skill documentation-structure
Clone the repo
git clone --depth 1 https://github.com/miroapp/miro-ai

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for documentation-structure

README.md
[![agentmods](https://agentmods.dev/badge/skills/miroapp/miro-ai/documentation-structure.svg)](https://agentmods.dev/skills/miroapp/miro-ai/documentation-structure)
Your own site
<a href="https://agentmods.dev/skills/miroapp/miro-ai/documentation-structure"><img src="https://agentmods.dev/badge/skills/miroapp/miro-ai/documentation-structure.svg" alt="Measured on agentmods" height="20"></a>
Per session 46 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,169 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00046 $0.01169
Opus 5 $0.00023 $0.00584
Sonnet 5 $0.00009 $0.00234
Haiku 4.5 $0.00005 $0.00117

Measured 4d ago against content hash 6c3263b1f3b6, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

documentation-structure scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 4d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

.agents/skills/documentation-structure/SKILL.md · 172 lines

How it starts

The opening of the file, as written. The whole thing — 172 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Documentation Structure

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

Core Principles

Principle Description
Separation of Concerns README (landing), docs/ (reference), CONTRIBUTING (dev workflow)
Single Source of Truth Define once, link everywhere. Never duplicate content.
Hub-and-Spoke docs/README.md is the central navigation hub
Vendor Isolation Each 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 Type User Docs Developer 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

Read the full file on GitHub · 172 lines

Files

What ships with it

1 file beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 4d ago First seen · 172 lines · 46 tokens per session scan A 6c3263b1f3b6

Subscribe to this mod's changes

documentation-structure is a skill published in the GitHub repository miroapp/miro-ai (151 stars, last pushed 9d ago), licensed MIT. It adds 46 tokens to every session and 1,169 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens