documentation-and-adrs

Document architectural decisions and create ADRs with templates and verification checklists.

Updated Mar 28, 2026

Search Tags:#changelog #architecture #documentation #adr #readme #guidelines

Ready to run

npx skills add https://github.com/1J6K21/build4good --skill documentation-and-adrs-1j6k21

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/1J6K21/build4good/tree/main/.gemini/skills/documentation-and-adrs
Command: npx skills add https://github.com/1J6K21/build4good --skill documentation-and-adrs-1j6k21

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It helps teams preserve the rationale behind architectural, API, and feature decisions, preventing loss of context and reducing future misunderstandings.

Core Features & Use Cases

Provides an ADR template and lifecycle guidance.
Defines best practices for inline comments, README structure, and changelog maintenance.
Offers verification checklists to ensure essential documentation is present.
Use case: When adopting a new authentication strategy, use this Skill to draft an ADR that records options, the chosen solution, and its trade‑offs.

Quick Start

Ask the skill to draft an ADR for a new database choice using the provided template.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema

How do I document architectural decisions for a new feature release?▼

To document architectural decisions, draft an Architecture Decision Record using a template to capture design options, the chosen solution, and trade-offs. This preserves the rationale behind API changes and feature releases for future clarity.

What is an ADR and when do I need to create one for my codebase?▼

An ADR is an Architecture Decision Record that captures the context and rationale behind a design choice. You need to create one when teams adopt new strategies, make API changes, or choose technologies, ensuring the reasoning is preserved.

How do I maintain a consistent README structure and changelog following best practices?▼

Maintain a consistent README structure and changelog by applying defined best-practice guidelines and verification checklists. This enforces uniform documentation structure and ensures essential project context is present.

Can I track the lifecycle of an architecture decision record as it evolves?▼

Yes, you can track the ADR lifecycle through defined guidelines. Tracking the lifecycle of an architecture decision record ensures that the status of design choices remains transparent and verifiable as the codebase evolves.

What is the best way to record trade-offs when adopting a new authentication strategy?▼

The best way to record trade-offs is to draft an ADR that explicitly documents the evaluated options, the chosen authentication solution, and its specific trade-offs. This prevents future misunderstandings about the design choice.

Do I need a verification checklist to ensure essential documentation is present?▼

Yes, a verification checklist is needed to ensure essential documentation is present. It helps enforce consistent documentation structure and verifies that all required architectural context and rationale are captured.