Skip to content
OpenSmartRoute
Skillv1.0.0

documentation-production

Use when generating, updating, or organizing documentation (component/API docs, project indexes, diagrams, tutorials, learning paths) - provides structured workflows and references for docs generation

by nickcrew(0) 0 installs
Free
Sign in to install

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Imported from nickcrew/claude-cortex (skills/documentation-production/SKILL.md). Install upstream with npx skills add nickcrew/claude-cortex --skill documentation-production. Copyright stays with the author.

Documentation Production

Overview

Provide a consistent, low-friction workflow for producing documentation across formats: focused docs, indexes, diagrams, tutorials, and learning paths. Keep outputs structured and aligned with the repo's docs conventions.

When to Use

  • Generating or updating documentation for components, APIs, or features
  • Building a project index or knowledge base
  • Creating Mermaid diagrams for system behavior or architecture
  • Writing tutorials, workshops, or learning paths
  • Explaining concepts for onboarding or education

Avoid when:

  • The request is primarily a code change (use implementation workflows)
  • The doc type is a one-off note that doesn't need structure

Quick Reference

Task Load reference
Generate focused docs skills/documentation-production/references/generate.md
Project index/knowledge base skills/documentation-production/references/index.md
Mermaid diagrams skills/documentation-production/references/diagrams.md
Teach concepts / learning paths skills/documentation-production/references/teacher.md
Tutorials / workshops skills/documentation-production/references/tutorials.md
Writing process & style skills/documentation-production/references/writing-process.md

Workflow

  1. Identify doc type and target audience.
  2. Load the relevant reference file(s) for structure and patterns.
  3. Gather source material from code or existing docs.
  4. Produce the artifact using the required format.
  5. Validate accuracy and consistency with repo conventions.
  6. Summarize changes and next steps.

Output

  • The documentation artifact(s)
  • Brief change summary and any follow-up gaps

Common Mistakes

  • Skipping source review and guessing behavior
  • Mixing tutorial/guide formats without clear intent
  • Creating diagrams without labels or accessibility notes
  • Updating docs without adjusting indexes or nav links

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

yaml
targets:
  - https://api.opensmartroute.ai/api/v1/registry/nickcrew-claude-cortex-documentation-production/manifest   # or paste the manifest below

Manifest

An Open Capability Manifest: the router reads it to know what this does, what it costs and when to pick it.

nickcrew-claude-cortex-documentation-production.ocm.jsonjson
{
  "ocm": "1",
  "id": "nickcrew-claude-cortex-documentation-production",
  "kind": "skill",
  "name": "documentation-production",
  "description": "Use when generating, updating, or organizing documentation (component/API docs, project indexes, diagrams, tutorials, learning paths) - provides structured workflows and references for docs generation, indexing, diagrams, and teaching.",
  "publisher": "nickcrew",
  "version": "1.0.0",
  "capabilities": {
    "domains": [
      "coding"
    ],
    "tags": [
      "skill-md",
      "doc-index",
      "documentation",
      "generate-docs",
      "learning-path",
      "mermaid-diagram",
      "sequence-diagram",
      "tutorial",
      "skills-sh"
    ],
    "languages": [
      "en"
    ]
  },
  "quality_prior": 0.6,
  "examples": [
    "Use when generating, updating, or organizing documentation (component/API docs, project indexes, diagrams, tutorials, learning paths) - provides structured workflows and references for docs generation, indexing, diagrams, and teaching."
  ],
  "primary": false,
  "metadata": {
    "source": {
      "provider": "skills.sh",
      "repository": "https://github.com/nickcrew/claude-cortex",
      "path": "skills/documentation-production/SKILL.md",
      "ref": "HEAD",
      "url": "https://github.com/nickcrew/claude-cortex/blob/HEAD/skills/documentation-production/SKILL.md",
      "key": "nickcrew/claude-cortex/skills/documentation-production/SKILL.md"
    }
  },
  "instructions": "# Documentation Production\n\n## Overview\nProvide a consistent, low-friction workflow for producing documentation across formats: focused docs, indexes, diagrams, tutorials, and learning paths. Keep outputs structured and aligned with the repo's docs conventions.\n\n## When to Use\n- Generating or updating documentation for components, APIs, or features\n- Building a project index or knowledge base\n- Creating Mermaid diagrams for system behavior or architecture\n- Writing tutorials, workshops, or learning paths\n- Explaining concepts for onboarding or education\n\nAvoid when:\n- The request is primarily ",
  "cost": {
    "context_tokens": 485
  }
}

Fetch it by URL: GET /api/v1/registry/nickcrew-claude-cortex-documentation-production/manifest?version=1.0.0

Reviews

Star ratings from people who tried it. One review per account; edit yours any time.

No reviews yet. Install it, try it, and be the first to rate it.