documentation-as-code

Name: documentation-as-code
Availability: InStock
Author: mcj-coder

Lint, spell-check, and validate links in Markdown documentation files.

1|1|Updated Jan 3, 2026

Search Tags:#ci/cd #linting #documentation #markdown #adr #spell check

Ready to run

npx skills add https://github.com/mcj-coder/development-skills --skill documentation-as-code-mcj-coder

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-as-code
Source: https://github.com/mcj-coder/development-skills/tree/main/skills/documentation-as-code
Command: npx skills add https://github.com/mcj-coder/development-skills --skill documentation-as-code-mcj-coder

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures documentation is treated with the same rigor as source code, preventing errors, inconsistencies, and broken links that can mislead users and stakeholders.

Core Features & Use Cases

Automated Validation: Enforces consistent formatting, spelling, and link integrity for Markdown, ADRs, and other documentation.
Standardized Templates: Ensures documentation follows predefined structures for clarity and completeness.
Use Case: When a developer submits a Pull Request with updated README files, this Skill automatically runs linters and spell checkers, failing the PR if any issues are found, thus maintaining high documentation quality.

Quick Start

Use the documentation-as-code skill to validate the markdown formatting and spelling of all files in the 'docs/' directory.

Frequently Asked Questions about documentation-as-code

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I enforce markdown linting and spell checking in a CI/CD pipeline?▼

To enforce markdown linting and spell checking in a CI/CD pipeline, integrate automated validation tools that check formatting, spelling, and link integrity, failing pull requests when documentation issues are detected.

What is the documentation-as-code approach for managing Architecture Decision Records?▼

The documentation-as-code approach for Architecture Decision Records applies automated linting and standardized templates to ADRs, ensuring consistent documentation quality and structural adherence through pre-commit hooks and CI/CD pipelines.

Can I use pre-commit hooks to validate markdown links and formatting?▼

Yes, pre-commit hooks can validate markdown links and formatting by running automated linters and spell checkers locally before code submission, ensuring consistent documentation quality and adherence to predefined templates.

What's the best way to automate documentation quality checks for project plans?▼

Automating documentation quality checks for project plans is best achieved by integrating automated linting, spell checking, and link validation into CI/CD pipelines, enforcing code-like quality standards for project plan modifications.

Does treating documentation like code prevent broken links in Markdown files?▼

Treating documentation like code prevents broken links in Markdown files through automated link validation integrated within pre-commit hooks and CI/CD pipelines, catching inconsistencies before pull requests are merged.