decision-record

Name: decision-record
Availability: InStock
Author: xantibody

Create structured decision records from executed plans or technical decisions.

1|Updated Dec 12, 2024

Search Tags:#git #documentation #decision record #adr #plan execution #technical decision

Ready to run

npx skills add https://github.com/Xantibody/dotfiles --skill decision-record-xantibody

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: decision-record
Source: https://github.com/Xantibody/dotfiles/tree/main/configs/claude/skills/decision-record
Command: npx skills add https://github.com/Xantibody/dotfiles --skill decision-record-xantibody

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you systematically document significant technical decisions, their rationale, and outcomes, creating a clear and accessible record for your team.

Core Features & Use Cases

Automated Decision Recording: Generates structured decision records (ADRs) based on executed plans or standalone discussions.
Contextual Information Gathering: Pulls relevant details from plan files, git history, and pull requests.
Use Case: After completing a complex feature implementation, use this Skill to create a decision record detailing why certain architectural choices were made, what was implemented, and what was deferred.

Quick Start

Use the decision-record skill to create a decision record from the executed plan in ./plans/new-feature-plan.md.

Frequently Asked Questions about decision-record

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

FAQPage Schema

How do I document technical decisions and outcomes after executing a plan?▼

To document technical decisions and outcomes, you can generate structured decision records that capture the rationale, implementation details, and future considerations from your executed plans or standalone discussions.

What is the best way to create an Architectural Decision Record (ADR) from git history?▼

Creating an Architectural Decision Record (ADR) from git history involves pulling contextual details from commits and pull requests to systematically document why specific architectural choices were made.

Can I generate decision records from standalone technical decisions without a formal plan?▼

Yes, you can generate decision records from standalone technical decisions without a formal plan by capturing the rationale and implementation details directly from discussions and contextual code history.

Do I need the gh CLI to integrate decision records with GitHub context?▼

You need the gh CLI dependency to integrate decision records with GitHub context, allowing the system to automatically pull relevant details from your pull requests and repository history.

What should be included in a post-plan execution summary for software engineering?▼

A post-plan execution summary should include the architectural rationale, implementation details, actual outcomes, and future considerations to provide a clear and accessible technical decision record for your team.