Skip to content

erikkai/docdocgoose

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Doc Doc Goose - Documentation Drift Detection and Verification

NOTE: MVP work is still in progress. The goal of Doc Doc Goose is to verify that documentation instructions actually work by executing code samples and commands in controlled environments, while mapping relationships between documentation files and associated code. When code changes affect a document, engineers can be alerted immediately that the documentation may require review.

Quick Demo

$ ddg init 
🪿 DocDocGoose directories are ready!
Link checker successfully installed.

$ ddg scan
🪿 Scanning for documentation health...
doc_samples/doc_1.md    fresh
doc_samples/doc_2.md   due
Scan complete.
Log written to .docdocgoose/logs/scan_log.json

Sample output:

[
  {
    "document": "doc_samples/doc_1.md",
    "url": "https://github.com/erikkai/docdocgoose_test_repo/blob/main/doc_samples/doc_1.md",
    "priority": "P1",
    "status": "fresh",
    "last_modified": "2026-03-10T21:34:55Z"
  },
  {
    "document": "doc_samples/doc_2.md",
    "url": "https://github.com/erikkai/docdocgoose_test_repo/blob/main/doc_samples/doc_2.md",
    "priority": "P1",
    "status": "due",
    "last_modified": "2026-02-20T10:12:11Z"
  }
]

Try it Out

If you want to try Doc Doc Goose, a sample repository is available: docdocgoose_test_repo

The sample repository contains setup instructions and example files so you can experiment with Doc Doc Goose without modifying your own project.

The Problem

Technical documentation easily becomes inaccurate over time. Commands change, dependencies update, links break, formatting styles evolve, and instructions stop working. As documentation grows, the content can also become disorganized, making it difficult for users to find what they need.

The Solution (Current MVP)

Doc Doc Goose addresses documentation rot by monitoring documentation and detecting when information may have become outdated or invalid.

The current CLI MVP focuses on a few core capabilities:

  • Detect when documentation may be stale based on configurable review priorities
  • Check documentation for broken links
  • Generate structured scan logs showing which documentation may need review

The Solution (Planned Capabilities)

Future versions of Doc Doc Goose will expand documentation monitoring to automatically detect additional types of issues.

Doc Doc Goose will:

  • Execute code samples from your documentation in controlled environments to verify they still run
  • Run installation commands and bash scripts to confirm setup instructions still work
  • Detect documentation drift by mapping relationships between documentation, code, and key project files
  • Validate documentation formatting and style rules using configurable linting tools such as Vale
  • Surface documentation health signals, including page usage metrics and optional user feedback per page

Doc Doc Goose will also include the following additional capabilities:

  • A dashboard for monitoring documentation across multiple repositories
  • The ability to add your content to a retrieval-augmented generation (RAG) system that fetches information from your documentation to provide tailored responses to users

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages