god-docs

Detect stale architectural documentation using a deterministic dirty-check algorithm.

Updated Feb 10, 2026
One-click install
npx skills add https://github.com/delorenj/00_ceiling --skill god-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: god-docs
Source: https://github.com/delorenj/00_ceiling/tree/main/god-docs
Command: npx skills add https://github.com/delorenj/00_ceiling --skill god-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the common issue of documentation becoming outdated and inaccurate as code evolves, ensuring that architectural documentation remains a reliable source of truth.

Core Features & Use Cases

  • Automated Staleness Detection: Automatically identifies when documentation is out of sync with code changes.
  • Dependency Tracking: Manages and verifies inter-document dependencies to ensure consistency across the system.
  • Use Case: When you modify a component's API, this Skill will automatically flag its corresponding GOD Doc as stale, prompting you to update it before merging your changes.

Quick Start

Run the god-check script to verify the freshness of all GOD documentation.

Frequently Asked Questions about god-docs

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

FAQPage Schema
How do I keep architectural documentation in sync with code changes?

You can enforce documentation freshness by running the dedicated god-check CLI tool to audit your repository. This script verifies that all developer-facing documents are synchronized with recent code modifications.

How does automated staleness detection work for multi-component repositories?

By utilizing git hooks and CI actions, the system automatically identifies when documentation falls out of sync. It prompts developers to update the relevant GOD Doc before merging any flagged component changes.

Can I use git hooks and CI actions to enforce documentation updates?

The Skill integrates directly into your existing DevOps pipeline. When component APIs are modified, the automated checks prompt developers to update the affected documentation before code can be successfully merged.

What is the required structure for documentation managed by this dirty-check algorithm?

Your repository must adhere to this specific template-based documentation structure. This allows the deterministic dirty-check algorithm to correctly audit and verify the freshness of inter-dependent architectural documents.

What are the limitations of using a deterministic dirty-check algorithm for documentation freshness?

The system relies heavily on consistent dependency tracking and layered enforcement. If your architectural documentation does not map cleanly to the required templates, the automated staleness detection may produce inaccurate results.