gd-document

Community

Streamline technical documentation updates across projects.

Authorcarlosamesar
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill addresses the challenge of maintaining consistent and comprehensive documentation during software development and architectural updates.

Core Features & Use Cases

  • Create or update README files within affected modules, ensuring documentation reflects current changes.
  • Generate and manage Architecture Decision Records (ADRs) for pivotal design choices, facilitating knowledge sharing.
  • Update API documentation in OpenAPI or markdown formats when API endpoints evolve.
  • Maintain an organized changelog with detailed release notes.
  • Develop operational runbooks for deployment or migration steps, supporting operational readiness.

Quick Start

Use the gd-document skill to automatically update the module README and generate ADRs for recent architecture decisions.

Dependency Matrix

Required Modules

None required

Components

scriptsreferences

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: gd-document
Download link: https://github.com/carlosamesar/framework-sdd/archive/main.zip#gd-document

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.