playbooks

home / skills / zpankz / mcp-skillset / documentation-router

documentation-router skill

/documentation-router

This skill routes documentation tasks by category, generating code, project, release, or API docs with clear explanations.

npx playbooks add skill zpankz/mcp-skillset --skill documentation-router

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

Files (2)
SKILL.md
1.8 KB
---
name: documentation-router
description: Routes documentation and explanation tasks. Triggers on document, explain, readme, api-docs, changelog, guide, comment, describe, write-docs.
---

# Documentation Router

Routes documentation, explanation, and writing tasks.

## Subcategories

### Code Documentation
```yaml
triggers: [comment, docstring, jsdoc, type-doc]
skills:
  - sc:document: Focused component documentation
  - sc:explain: Clear explanations
```

### Project Documentation
```yaml
triggers: [readme, guide, setup, installation, contributing]
skills:
  - dev:documentation:create-readme-section: README sections
  - sc:index: Comprehensive documentation
```

### Release Documentation
```yaml
triggers: [changelog, release-notes, version, breaking-changes]
skills:
  - dev:documentation:create-release-note: Release notes
```

### API Documentation
```yaml
triggers: [api-docs, endpoints, swagger, openapi]
skills:
  - sc:document: API documentation
  - sc:design: API design
```

## Routing Decision Tree

```
documentation request
    │
    ├── Code-level?
    │   ├── Comments? → sc:document
    │   └── Explanation → sc:explain
    │
    ├── Project-level?
    │   ├── README? → create-readme-section
    │   └── Full docs → sc:index
    │
    ├── Release?
    │   └── create-release-note
    │
    └── API?
        └── sc:document
```

## Managed Skills

| Skill | Purpose | Trigger |
|-------|---------|---------|
| sc:document | Component docs | "document", "describe" |
| sc:explain | Explanations | "explain", "clarify" |
| sc:index | Full documentation | "index", "comprehensive" |
| create-readme-section | README | "readme", "setup guide" |
| create-release-note | Release notes | "changelog", "release" |

Overview

This skill routes documentation, explanation, and writing requests to the most appropriate documentation helper. It detects intent from triggers like document, explain, readme, api-docs, changelog, guide, comment, describe, and write-docs. The router maps requests to focused sub-skills for code comments, project READMEs, API docs, and release notes. It speeds work by sending each task to the skill best suited to produce accurate, targeted documentation.

How this skill works

The router inspects the task type and trigger words to classify the request into code-level, project-level, release, or API documentation. Based on the classification it forwards the request to a managed skill such as component documentation, explanations, README section creation, full docs indexing, or release-note authoring. A simple decision tree determines the destination: comments and docstrings go to component docs or explainers, README and guides go to README/ index skills, API triggers route to API documentation skills, and changelog triggers route to release-note creation. This keeps responses focused and consistent by leveraging specialized generators.

When to use it

  • You need a concise component comment, docstring, or JSDoc for a function or class.
  • You want a clear explanation or walkthrough of code behavior or design decisions.
  • You are building or extending a project README, setup guide, or contribution guide.
  • You must create changelog entries or formal release notes for a version.
  • You need API reference pages, endpoint descriptions, or OpenAPI-compatible docs.

Best practices

  • Provide the trigger word and short context (file, function, or endpoint) to improve routing accuracy.
  • Include example inputs/outputs or code snippets for code-level documentation tasks.
  • For project-level docs, supply project purpose, audience, and setup steps to shape README sections.
  • For releases, include a concise list of changes, breaking changes, and migration notes.
  • When documenting APIs, include endpoint paths, parameters, request/response examples, and auth requirements.

Example use cases

  • Add JSDoc comments to a React component method using the code-level route.
  • Generate a clear explanation of a complex algorithm for a CONTRIBUTING or docs page.
  • Create a new Getting Started section in the README that outlines installation and usage.
  • Produce a release note entry summarizing features, bug fixes, and breaking changes for v2.1.0.
  • Draft OpenAPI-style endpoint descriptions for backend routes to include in API docs.

FAQ

What happens if a request matches multiple triggers?

The router applies the decision tree priority: code-level and explanation triggers are checked first, then project-level, release, and API routes; it selects the most specific match.

Can I override the routing decision?

Yes. Specify the desired target skill or add explicit context (e.g., 'create-readme-section' or 'sc:document') to force the route.