moai-docs-validation

Validate documentation against SPECs and MoAI-ADK standards.

Updated Nov 24, 2025
One-click install
npx skills add https://github.com/jg-chalk-io/Nora-LiveKit --skill moai-docs-validation-jg-chalk-io
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: moai-docs-validation
Source: https://github.com/jg-chalk-io/Nora-LiveKit/tree/main/.claude/skills/moai-docs-validation
Command: npx skills add https://github.com/jg-chalk-io/Nora-LiveKit --skill moai-docs-validation-jg-chalk-io

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Manual documentation validation is time-consuming, error-prone, and struggles to maintain consistency across large projects and multiple languages. This skill automates the process, ensuring accuracy, completeness, and compliance with MoAI-ADK standards. It helps catch inaccurate documentation before publication, ensuring traceability and maintaining high-quality standards.

Core Features & Use Cases

  • SPEC Compliance: Automatically verify documentation references valid SPECs and TAG chains.
  • Content Accuracy: Validate code examples, API signatures, and configuration patterns against actual implementations.
  • Multilingual Consistency: Ensure structural and content alignment across different language versions of your documentation.
  • CI/CD Integration: Automate quality gates in your development pipeline to prevent inaccurate documentation from being published, enforcing quality standards.

Quick Start

Use the moai-docs-validation skill to validate the documentation for the 'user-authentication' feature, focusing on SPEC compliance and code example accuracy.

Frequently Asked Questions about moai-docs-validation

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

FAQPage Schema
How do I automate documentation validation in CI/CD pipelines?

Documentation validation automates quality checks within CI/CD workflows to catch inaccurate content before publication. This skill validates code examples, API signatures, SPEC compliance, and multilingual consistency, enforcing standards across feature docs, API references, and configuration guides automatically.

Can I validate API documentation against actual code signatures?

Yes. The skill verifies API signatures, parameters, and return values against implementations, plus validates code examples and configuration patterns for accuracy. It also checks syntax and signatures in code blocks to ensure documentation matches your codebase.

How do I ensure multilingual documentation stays consistent?

Multilingual consistency validation checks structural and content alignment across language versions of your documentation. The skill detects divergences between translations and ensures all localized docs maintain the same quality and accuracy standards.

What does SPEC compliance validation check in documentation?

SPEC compliance validation verifies that documentation references valid SPECs and TAG chains according to MoAI-ADK standards. It ensures your docs meet compliance requirements and maintain traceability within your specification framework.

Does documentation validation work with multilingual projects at scale?

Yes. The skill handles large projects across multiple languages, applying automated validation rules and quality scoring to enforce standards consistently. It scales across feature docs, API references, and configuration guides regardless of project size or language count.

What quality metrics does documentation validation measure?

The skill calculates a quality score based on completeness, readability, content accuracy, and compliance. It implements automated validation rules, syntax checks, and parameter verification to produce a comprehensive quality assessment for each document.