speckit-docguard-fix

Name: speckit-docguard-fix
Availability: InStock
Author: Kami

Generate canonical architecture, data model, test, security, environment, and API documentation from codebases.

Updated May 18, 2026

Search Tags:#architecture #documentation #codebase #api reference #spec kit #docguard

Ready to run

npx skills add https://github.com/KamiJeong/tech-bridge-book --skill speckit-docguard-fix

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: speckit-docguard-fix
Source: https://github.com/KamiJeong/tech-bridge-book/tree/main/.agents/skills/speckit-docguard-fix
Command: npx skills add https://github.com/KamiJeong/tech-bridge-book --skill speckit-docguard-fix

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you reverse-engineer a codebase into standardized documentation when the architecture, data model, tests, security posture, or API details are not clearly documented.

Core Features & Use Cases

Canonical Document Generation: Produces core reference docs such as architecture, data model, test spec, security, environment, and API reference.
Codebase-Driven Analysis: Derives documentation from actual routes, schemas, configs, test files, and other source artifacts.
Use Case: A team inheriting an existing project can quickly generate a consistent documentation set to support onboarding, audits, and maintenance planning.

Quick Start

Ask the skill to generate canonical documentation for the current project using DocGuard.

Frequently Asked Questions about speckit-docguard-fix

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

FAQPage Schema

How do I generate canonical documentation from an existing codebase?▼

To generate canonical documentation from a codebase, this Skill extracts architecture, data model, security, environment, and API details directly from your source code, configs, schemas, and test artifacts. It produces a standardized technical reference set for onboarding and maintenance.

Can I generate API reference and security docs from source code automatically?▼

Yes, you can generate API reference and security documentation from source code automatically. The Skill derives these canonical docs by analyzing actual routes, schemas, configs, and test artifacts present in your repository.

Do I need a Spec Kit project structure to generate technical docs?▼

Yes, you need a Spec Kit project structure with a .specify directory to use this documentation generation Skill. The Skill relies on this existing directory structure to parse the codebase and generate standardized technical documentation.

What is the best way to document an inherited codebase for onboarding?▼

The best way to document an inherited codebase for onboarding is to reverse-engineer it into a consistent documentation set. This Skill extracts architecture, data models, and API details from source artifacts to quickly produce standardized reference documents.

Can I generate documentation for a specific domain like data models only?▼

Yes, you can generate documentation for a specific domain like data models only. The Skill supports targeted document generation, allowing you to extract and produce canonical docs for specific technical areas rather than the entire codebase at once.