code-documentation-standards

What problem does it solve?

Codebases often suffer from out-of-date, inconsistent documentation that lags behind code changes. This Skill provides comprehensive standards, templates, and validation practices to ensure documentation stays aligned with implementation, reducing onboarding time and maintenance costs.

Core Features & Use Cases

• Pre-commit Markdown validation: Enforces syntax, links, and structure across all Markdown docs before changes are committed.
• Documentation templates: Provides ready-to-use templates for Python functions/classes, HTML/CSS/JavaScript components, and API documentation to standardize style.
• Guided workflow for teams: Supports code reviews and onboarding by ensuring code changes are accompanied by matching documentation updates.
• Validation workflow: Outlines a repeatable process for Markdown validation, block tests, and link checks to maintain quality.

Quick Start

1. Integrate a Markdown linting step in your local workflow (e.g., run markdownlint on all .md files).
2. Use the provided templates to document new modules, classes, and functions as part of every change.
3. Before committing, follow the validation process to fix syntax errors, broken links, and formatting issues.