gooddocs

Audit documentation against code changes and report drift inconsistencies.

2|1|Updated Aug 23, 2025
One-click install
npx skills add https://github.com/neozenith/agentic-dotfiles --skill gooddocs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gooddocs
Source: https://github.com/neozenith/agentic-dotfiles/tree/main/skills/gooddocs
Command: npx skills add https://github.com/neozenith/agentic-dotfiles --skill gooddocs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, bunx, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill helps maintain the quality and structure of documentation, ensuring it accurately reflects code changes and adheres to best practices.

Core Features & Use Cases

  • Audit: Corroborate that documentation matches code and reports on drift.
  • Write: Author or rewrite documentation using a lens taxonomy and style principles.
  • Restructure: Reorganize existing documentation for better readability without changing claims.
  • Use Case: If you have a project with documentation that needs regular updates to match evolving code, this Skill can automate the process and enforce quality standards.

Quick Start

Use the gooddocs skill to audit all documentation:

/gooddocs

Frequently Asked Questions about gooddocs

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

FAQPage Schema
How do I verify my documentation matches the current codebase?

To verify documentation matches your codebase, you can audit it to detect drift. This process corroborates documentation claims against code and reports inconsistencies using subagents.

What is the best way to restructure markdown documentation for readability?

Restructuring markdown documentation improves readability without altering technical claims. It reorganizes existing content using a Diátaxis lens taxonomy and style principles to maintain structure.

Do I need git and bunx to run a documentation audit?

Yes, running a documentation audit requires git and bunx. Git tracks codebase changes while bunx performs link checking, and both are necessary for subagent support.

What is documentation drift and how do I report inconsistencies?

Documentation drift occurs when documentation no longer matches evolving code. You can report inconsistencies by running an audit that uses Python subagents to verify claims and highlight mismatches.

How do I maintain documentation quality when updating code?

To maintain documentation quality when updating code, automate regular audits to enforce quality standards. This ensures your documentation accurately reflects code changes and adheres to best practices.