skills.rest
basmawebinfo-hub
basmawebinfo-hubCOMMUNITY
Explore all skills by this author →
GitHub

docs-guard

Verify technical documentation claims against source code evidence.

Updated Jun 14, 2026
Search Tags:#documentation#drift detection#readme#docstrings#accuracy#code samples#doc review
One-click install
npx skills add https://github.com/basmawebinfo-hub/lover-diet-center --skill docs-guard
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docs-guard
Source: https://github.com/basmawebinfo-hub/lover-diet-center/tree/main/.opencode/skills/docs-guard
Command: npx skills add https://github.com/basmawebinfo-hub/lover-diet-center --skill docs-guard

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps prevent inaccurate, stale, or hallucinated technical documentation from reaching users. It treats documentation as a set of verifiable claims and checks those claims against the actual codebase, configuration, routes, flags, and examples.

Core Features & Use Cases

  • Documentation Fact-Checking: Verifies symbols, function names, CLI flags, endpoints, config keys, file paths, and behavior claims against source code.
  • Code Sample Validation: Reviews examples for real imports, correct signatures, realistic placeholders, and runnable setup on a clean machine.
  • Cross-Surface Drift Detection: Checks whether READMEs, references, docstrings, changelogs, and config samples stay consistent after code changes.
  • Review Reporting: Produces structured findings with rule-based severity and file:line evidence for false or unverifiable claims.
  • Use Case: After an AI updates a README and API docstrings for a feature rename, use this Skill to confirm every referenced symbol exists, examples still work, and old names were removed from all documentation surfaces.

Quick Start

Ask the agent to use the docs-guard skill to review the changed README and docstrings against the current source before publishing.

Frequently Asked Questions about docs-guard

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

FAQPage Schema
How do I check if my README and docstrings match the actual source code?▼

To verify documentation accuracy against source code, treat docs as verifiable claims and validate symbols, function names, and file paths against repository evidence to catch stale references and false claims before release.

What is the best way to detect documentation drift after a feature rename?▼

Documentation drift detection checks whether READMEs, API references, docstrings, and changelogs stay consistent after code changes by validating referenced symbols, endpoints, and config keys against the updated source code.

How do I validate code samples in technical tutorials before publishing?▼

Code sample validation reviews examples for real imports, correct signatures, realistic placeholders, and runnable setup on a clean machine to ensure technical tutorials execute without errors.

Can I verify API endpoints and CLI flags documented in my configuration files?▼

Yes, you can verify API endpoints and CLI flags by checking those configuration claims against actual routes, flags, and source code symbols to confirm they exist and match the documented behavior.

How do changelogs get reviewed for false or unverifiable claims?▼

Review reporting produces structured findings with rule-based severity and file:line evidence for false or unverifiable claims by validating changelog entries against repository evidence and actual code changes.

Does documentation fact-checking work for internal links and version references?▼

Documentation fact-checking requires claim-by-claim validation of internal links, versions, and sample correctness using repository evidence to ensure all references resolve accurately before release.

Related Skills

Explore More Software Engineering Skills→
pckienuitpckienuit

codegraph

Find code symbols and trace dependency paths in a repository.

Community
Intermediate
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced
abdullah1854abdullah1854
1

memory-systems

Design memory architectures with vector stores, knowledge graphs, and temporal knowledge graphs.

Community
Advanced
ganeshgaxyganeshgaxy

noob-explore

Execute one pre-claimed UI test case via browser automation.

Community
Advanced