skills.rest
manhua-man
manhua-manCOMMUNITY
Explore all skills by this author →
GitHub

grill-me-docs

Audits markdown documentation against codebase entities, DTOs, and controllers for consistency.

1|Updated Jun 10, 2026
Search Tags:#markdown#technical writing#verification#spec review#nestjs#code consistency#documentation audit
One-click install
npx skills add https://github.com/manhua-man/session-distill-skills --skill grill-me-docs-manhua-man
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: grill-me-docs
Source: https://github.com/manhua-man/session-distill-skills/tree/main/helpers/grill-me-docs
Command: npx skills add https://github.com/manhua-man/session-distill-skills --skill grill-me-docs-manhua-man

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Documentation drifts out of sync with code after refactors, leaving stale endpoint paths, renamed environment variables, and outdated table columns in specs. This Skill pressure-tests markdown docs against the actual codebase so discrepancies are caught with file-and-line evidence instead of being discovered by users. ## Core Features & Use Cases - Doc-vs-Code Auditing: Cross-references statements in docs/ markdown files against live entities, DTOs, controllers, and services using Read, Grep, and Glob. - Structured Verdicts: Classifies each finding as ACCURATE, STALE, CONTRADICTED, or MISSING_SPECS with quoted doc statements and code evidence links. - Use Case: After refactoring a NestJS API, run an audit on docs/04-开发指南/ to verify that endpoint paths, DTO fields, and environment variables cited in the guides still match the controllers, then receive a revision-ready report. ## Quick Start Audit the specification file docs/api-spec.md against the current NestJS server code and report any stale or contradicted statements with code evidence.

Frequently Asked Questions about grill-me-docs

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

FAQPage Schema
How do I check if my documentation matches my code?▼

Point the audit at a markdown spec file and the relevant source directory. Each documented claim is cross-referenced against actual controllers, DTOs, and entities, returning a verdict with quoted doc text and code evidence links.

What does a documentation consistency audit report include?▼

The report lists each finding with a verdict (ACCURATE, STALE, CONTRADICTED, or MISSING_SPECS), the exact doc statement with line number, a code evidence link with line range, and a recommended revision to align the doc with the code.

Can I audit NestJS API docs against controllers and DTOs?▼

Yes, the audit is designed for NestJS codebases, verifying endpoint paths, DTO fields, and service behavior cited in markdown guides against the actual controller and DTO source files.

Does the doc auditor modify my source code?▼

No, it operates read-only using Read, Grep, and Glob. It never alters production TypeScript or SQL code; it only outputs audit reports with recommended documentation edits.

When should I not rely on automated doc-vs-code auditing?▼

It verifies claims only against code it can read, so behavior defined by runtime configuration, external services, or undocumented business context may require manual review. It also does not judge writing quality, only factual consistency.

Related Skills

Explore More Software Engineering Skills→
amak07amak07

document-feature

Generate standardized feature documentation with Good Docs templates and Mermaid diagrams.

Community
Advanced
Xipher-LabsXipher-Labs
6

pr-review

Review pull requests against a multi-dimensional readiness checklist before merging.

Official
Advanced
jonkikyjonkiky

codex

Automate code review, adversarial testing, and Codex consultation via a Bash CLI.

Community
Advanced
AstyanMAstyanM
1

api-docs

Generate OpenAPI, Markdown, or Postman documentation from source code.

Community
Advanced