document-skills

Documentation skills — Mermaid, PlantUML, ProcessOn, API docs, full-stack-doc, MarkItDown (awesome / cli / ocr)

English | 简体中文

Introduction · Install · Skills · Supported Agents · Ecosystem

---

📖 Introduction

Documentation Skills is a curated collection of Agent Skills for AI coding agents, published in the Full Stack Skills ecosystem.

This package includes 11 skills. Each skill is a self-contained SKILL.md file that AI agents load on-demand.

📦 Install

npx skills add full-stack-skills/document-skills

Or install specific skills:

npx skills add full-stack-skills/document-skills --skill <skill-name>

🎯 Skills (11)

Skill	Description
api-doc-generator	Generate traceable API documentation from OpenAPI, routes, source, and tests
doc-coauthoring	Gather context, draft collaboratively, and run independent reader tests
full-stack-doc	Build an example-rich documentation system from lifecycle, README, Rust-profile, and complete architecture template families
markitdown-awesome	Overview & navigation for Microsoft MarkItDown — capabilities, supported formats, three-path decision tree (awesome / cli / ocr), and side-by-side comparison with textract / unstructured / pandoc / docling / Azure DI / Azure CU
markitdown-cli	Complete CLI guide for markitdown — every flag (-o/-x/-m/-c/-d/-e/-p/--use-cu/--cu-endpoint/--cu-analyzer/--cu-file-types/--list-plugins/--keep-data-uris), I/O matrix, shell-toolchain integration, Azure backends, troubleshooting
markitdown-ocr	Drive the markitdown-ocr plugin to run LLM Vision OCR (OpenAI-compatible, including Azure OpenAI / Gemini / local vLLM / Ollama) on PDF / DOCX / PPTX / XLSX embedded images and scanned pages — install, configuration, Python API, scanned-PDF full-page fallback, per-format behavior, custom prompts, cost & failure handling
mermaid	Create Mermaid diagrams that render directly in Markdown and README files
plantuml	Create precise UML, C4, and enterprise architecture source
processon-diagram-generator	Generate editable DSL and rendered images through the ProcessOn API
processon-mindmap	Organize a hierarchical mind map ready for ProcessOn
technical-blog-doc	Write reproducible technical tutorials with environment, commands, and evidence

full-stack-doc includes the original detailed root, version, module, and delivery templates plus Java, Rust, plugin, skill-ecosystem, and complete-reference README templates. The Rust common template composes with profiles for file formats, upstream parity, toolbox workspaces, authentication frameworks, design-only repositories, and multilingual layouts. Its complete architecture master composes with runtime, plugin, edge, event, AI/RAG, and observability/control-plane profiles. API discovery loads focused guidance for OpenAPI, Spring, FastAPI, NestJS, Express, or Gin.

✅ Quality checks

python3 scripts/validate_repository.py
python3 skills/full-stack-doc/scripts/validate_templates.py
python3 -m unittest discover -s skills/full-stack-doc/tests -p 'test_*.py'
python3 -m unittest discover -s skills/api-doc-generator/tests -p 'test_*.py'
python3 -m unittest discover -s skills/processon-diagram-generator/tests -p 'test_*.py'
python3 scripts/run_artifact_evals.py

Trigger positive/negative cases and artifact regression cases live under evals/.

🤖 Supported Agents

Works with Claude Code, Codex, Cursor, OpenCode, Gemini CLI, GitHub Copilot, Windsurf, and 70+ others.

Claude Code Installation

Option 1: npx skills CLI (Recommended)

npx skills add full-stack-skills/document-skills

Option 2: Manual Installation

git clone https://github.com/full-stack-skills/document-skills.git
cp -r document-skills/skills/* .claude/skills/

For more details, see the Claude Code Skills Guide and Agent Skills Spec.

🌐 Ecosystem

Resource	Link
Full Stack Skills	github.com/full-stack-skills
All Skill Groups	github.com/full-stack-skills
Agent Skills Spec	agentskills.io
Skills CLI	github.com/vercel-labs/skills

📄 License

Apache 2.0 — see LICENSE.