documentation-validation

Validate documentation completeness, format, and quality for plugins and marketplaces

8 stars

Best use case

documentation-validation is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Validate documentation completeness, format, and quality for plugins and marketplaces

Teams using documentation-validation should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/documentation-validation/SKILL.md --create-dirs "https://raw.githubusercontent.com/dhofheinz/open-plugins/main/plugins/marketplace-validator-plugin/commands/documentation-validation/skill.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/documentation-validation/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How documentation-validation Compares

Feature / Agentdocumentation-validationStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Validate documentation completeness, format, and quality for plugins and marketplaces

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

SKILL.md Source

You are the Documentation Validation coordinator, ensuring comprehensive and high-quality documentation.

## Your Mission

Parse `$ARGUMENTS` to determine the requested documentation validation operation and route to the appropriate sub-command.

## Available Operations

Parse the first word of `$ARGUMENTS` to determine which operation to execute:

- **readme** → Read `.claude/commands/documentation-validation/check-readme.md`
- **changelog** → Read `.claude/commands/documentation-validation/validate-changelog.md`
- **license** → Read `.claude/commands/documentation-validation/check-license.md`
- **examples** → Read `.claude/commands/documentation-validation/validate-examples.md`
- **full-docs** → Read `.claude/commands/documentation-validation/full-documentation.md`

## Argument Format

```
/documentation-validation <operation> [parameters]
```

### Examples

```bash
# Check README completeness
/documentation-validation readme path:. sections:"overview,installation,usage,examples"

# Validate CHANGELOG format
/documentation-validation changelog file:CHANGELOG.md format:keepachangelog

# Check LICENSE file
/documentation-validation license path:. expected:MIT

# Validate example quality
/documentation-validation examples path:. no-placeholders:true

# Run complete documentation validation
/documentation-validation full-docs path:.
```

## Documentation Standards

**README.md Requirements**:
- Overview/Description section
- Installation instructions
- Usage examples (minimum 2)
- Configuration options (if applicable)
- License information
- Length: Minimum 500 characters

**CHANGELOG.md Requirements**:
- Keep a Changelog format
- Version headers ([X.Y.Z] - YYYY-MM-DD)
- Change categories: Added, Changed, Deprecated, Removed, Fixed, Security
- Unreleased section for upcoming changes

**LICENSE Requirements**:
- LICENSE or LICENSE.txt file present
- Valid OSI-approved license
- License matches plugin.json declaration

**Examples Requirements**:
- No placeholder text (TODO, FIXME, XXX, placeholder)
- Complete, runnable examples
- Real values, not dummy data
- Proper formatting and syntax

## Quality Scoring

Documentation contributes to overall quality score:
- Complete README: +15 points
- CHANGELOG present: +10 points
- LICENSE valid: +5 points
- Quality examples: +10 points

## Error Handling

If the operation is not recognized:
1. List all available documentation operations
2. Show documentation standards
3. Provide improvement suggestions

## Base Directory

Base directory for this skill: `.claude/commands/documentation-validation/`

## Your Task

1. Parse `$ARGUMENTS` to extract operation and parameters
2. Read the corresponding operation file
3. Execute documentation validation checks
4. Return detailed findings with specific improvement guidance

**Current Request**: $ARGUMENTS

Related Skills

validation-orchestrator

8
from dhofheinz/open-plugins

Intelligent validation orchestrator with auto-detection and progressive validation workflows

schema-validation

8
from dhofheinz/open-plugins

Validate JSON schemas, required fields, and format compliance for marketplaces and plugins

specification-writing

8
from dhofheinz/open-plugins

Core reference for EARS requirement patterns, Given/When/Then acceptance criteria, RFC 2119 language, requirement ID conventions, and specification quality checklists. Background knowledge for the spec-writer agent. Preloaded by spec-writer via the skills frontmatter field; not user-invocable.

refine

8
from dhofheinz/open-plugins

Unified specification refinement plugin. Single entry point for all spec operations: greenfield architecture pipelines (principles → design → stack → spec → plan), feature spec creation in existing systems, iterative convergence loops, quality reviews, drift detection, finalization, ticket decomposition, traceable updates, and lifecycle archival. Detects pipeline state from existing artifact frontmatter and routes intelligently. Use whenever you need to create, refine, validate, or evolve a technical specification.

security-scan

8
from dhofheinz/open-plugins

Comprehensive security scanning for secrets, vulnerabilities, and unsafe practices

quality-analysis

8
from dhofheinz/open-plugins

Deep quality analysis with scoring, recommendations, and actionable reports

best-practices

8
from dhofheinz/open-plugins

Enforce OpenPlugins and Claude Code best practices for naming, versioning, and standards compliance

message-generation

8
from dhofheinz/open-plugins

Generate conventional commit messages following best practices

history-analysis

8
from dhofheinz/open-plugins

Analyze git history to learn project's commit style and conventions

commit-error-handling

8
from dhofheinz/open-plugins

Handle git errors and edge cases gracefully

commit-best-practices

8
from dhofheinz/open-plugins

Enforce git commit best practices and workflow guidance

commit-analysis

8
from dhofheinz/open-plugins

Analyze git changes to understand nature, scope, and commit type for intelligent message generation