mcpField
D
documentation-production

documentation-production

github.com/nickcrewDevelopment6292 installsUpdated 17w ago
Repository

About documentation-production

A documentation-production skill for developers and teams creating structured project docs, diagrams, tutorials, and learning paths. It uses repository conventions and reference guides to shape and validate each output.

Key features

  1. 01Generate focused documentation
  2. 02Build project indexes
  3. 03Create Mermaid diagrams
  4. 04Write tutorials and learning paths
  5. 05Follow repository conventions
  6. 06Validate accuracy and consistency

Use cases

  1. 01Documenting APIs or features
  2. 02Creating a project knowledge base
  3. 03Illustrating system behavior
  4. 04Preparing onboarding materials

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/nickcrew/claude-cortex --skill documentation-production

After installing, type/documentation-productionin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

references/
diagrams.md
generate.md
index.md
teacher.md
tutorials.md
writing-process.md

Details

From the project README

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

TaskLoad reference
Generate focused docsskills/documentation-production/references/generate.md
Project index/knowledge baseskills/documentation-production/references/index.md
Mermaid diagramsskills/documentation-production/references/diagrams.md
Teach concepts / learning pathsskills/documentation-production/references/teacher.md
Tutorials / workshopsskills/documentation-production/references/tutorials.md
Writing process & styleskills/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

Comments

Markdown supported