gd-document

Automate updates to READMEs, ADRs, API docs, and changelogs.

1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/carlosamesar/framework-sdd --skill gd-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gd-document
Source: https://github.com/carlosamesar/framework-sdd/tree/main/.opencode/skills/gd-document
Command: npx skills add https://github.com/carlosamesar/framework-sdd --skill gd-document

SYSTEM DOCUMENTATION & REQUIREMENTS

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

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.

Frequently Asked Questions about gd-document

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

FAQPage Schema
How do I automate technical documentation updates for API endpoints and modules?

Automate technical documentation updates by generating and managing README files, API docs, and changelogs to ensure project records accurately reflect iterative software development changes.

How do I create and manage Architecture Decision Records for software projects?

Create and manage Architecture Decision Records (ADRs) by automatically generating documentation for pivotal design choices, facilitating knowledge sharing and architectural tracking across software teams.

What is the best way to maintain an organized changelog during iterative development cycles?

Maintain an organized changelog by automatically documenting detailed release notes and module updates, ensuring project documentation remains comprehensive and adheres to documentation standards.

Can I generate API documentation in OpenAPI and markdown formats when endpoints evolve?

Generate API documentation in OpenAPI or markdown formats by updating existing project files automatically when API endpoints evolve, ensuring operational records remain comprehensive.

Does this documentation approach integrate with existing project files and operational runbooks?

This documentation approach integrates with existing project files to develop operational runbooks for deployment or migration steps, supporting operational readiness during architectural updates.

What types of technical documentation can I streamline across software projects?

Streamline technical documentation types including module README files, Architecture Decision Records, API docs, organized changelogs, and operational runbooks to maintain accurate and comprehensive project records.