doc-correctness

Verify documentation claims against source code, configs, and deployments.

4|8|Updated Mar 5, 2025
One-click install
npx skills add https://github.com/megaeth-labs/documentation --skill doc-correctness
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-correctness
Source: https://github.com/megaeth-labs/documentation/tree/main/.claude/skills/doc-correctness
Command: npx skills add https://github.com/megaeth-labs/documentation --skill doc-correctness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation sometimes drifts from implementation. This Skill verifies claims in documentation against source code, configurations, and deployments to ensure accuracy and reduce risk.

Core Features & Use Cases

  • Cross-check documentation claims against real code, configs, and deployment data.
  • Audit constants, addresses, RPC behavior documentation, and spec correctness.
  • Validate network parameters against actual sources and provide guidance for remediation.

Quick Start

Validate the alignment of a target doc page with its source by supplying the page path like docs/spec/evm/dual-gas-model.md to cross-check.

Frequently Asked Questions about doc-correctness

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

FAQPage Schema
How do I verify documentation claims against source code?

Verify documentation claims against source code by supplying a target page path to cross-check constants, addresses, and RPC behavior against authoritative implementation sources, ensuring factual accuracy.

What causes documentation to drift from implementation?

Documentation drifts from implementation when code, configurations, or deployments change without corresponding updates, requiring auditing to verify consistency and reduce factual inaccuracy risk.

Can I audit an entire layer of specifications for consistency?

Yes, you can audit an entire layer or the full documentation set to verify consistency across code, configs, and deployments by locating authoritative sources for each claim.

Does documentation auditing work for network parameters and RPC behavior?

Documentation auditing works for network parameters and RPC behavior by validating them against actual sources and providing guidance for remediation to ensure spec correctness.

What is the best way to check factual correctness in technical documentation?

The best way to check factual correctness in technical documentation is to identify and verify claims against implementation sources, confirming accuracy against the knowledge base and primary repositories.

When do I need to audit docs for spec correctness?

You need to audit docs for spec correctness when verifying alignment between target documentation pages and source code, especially after updates to constants, addresses, or deployment configurations.