documentation-standards

Name: documentation-standards
Availability: InStock
Author: SoftSpark

Validate KB Markdown files for frontmatter, naming, and English content.

161|21|Updated Mar 26, 2026

Search Tags:#documentation #validation #frontmatter #naming #ci #kb

Ready to run

npx skills add https://github.com/softspark/ai-toolkit --skill documentation-standards-softspark

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-standards
Source: https://github.com/softspark/ai-toolkit/tree/main/app/skills/documentation-standards
Command: npx skills add https://github.com/softspark/ai-toolkit --skill documentation-standards-softspark

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Inconsistent knowledge‑base documents cause CI failures and make searching difficult; this Skill ensures every KB file follows strict frontmatter, naming, language, and quality rules.

Core Features & Use Cases

Frontmatter enforcement: validates required fields and correct categories for all kb/**/*.md files.
Naming & language checks: guarantees kebab‑case filenames, English content, and proper tag usage.
CI integration: runs automatically via scripts/validate.py to block merges when standards are not met.
Typical use case: when a contributor adds or updates a SOP, the Skill validates the document and provides immediate feedback.

Quick Start

Request the assistant to verify a KB document meets the documentation standards.

Frequently Asked Questions about documentation-standards

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

FAQPage Schema

How do I validate frontmatter in KB markdown files during CI?▼

To validate frontmatter in KB markdown files, run a validation script during CI to enforce required fields, category-directory alignment, and non-empty tags. This prevents merges when knowledge base documents fail to meet strict documentation standards.

What is the best way to enforce naming conventions and English content for knowledge base documents?▼

Enforcing naming conventions and English content for knowledge base documents requires an automated validation script that checks for kebab-case filenames and language rules. This ensures consistent formatting and prevents CI pipeline failures caused by non-compliant files.

How do I block pull request merges when KB documentation standards are not met?▼

To block pull request merges when KB documentation standards are not met, integrate a validation script into your CI pipeline. The script checks frontmatter, naming, and language rules, automatically failing the build to prevent inconsistent documents from merging.

Does CI validation support troubleshooting and best-practice KB files?▼

CI validation supports troubleshooting and best-practice KB files by applying uniform checks across reference, how-to, procedures, and best-practice directories. It ensures all file types in the kb directory maintain consistent frontmatter and naming standards.

Why do my KB markdown files fail CI pipelines with frontmatter errors?▼

KB markdown files fail CI pipelines with frontmatter errors when required fields are missing, tags are empty, or category-directory alignment is broken. Running a validation script identifies these specific documentation standard violations before merge attempts.

Can I use automated validation to check required fields and tags across multiple KB directories?▼

You can use automated validation to check required fields and tags across multiple KB directories. The validation script applies frontmatter and naming rules uniformly to all markdown files within the kb directory structure, ensuring comprehensive coverage.