documentation-and-adrs

Name: documentation-and-adrs
Availability: InStock
Author: mymx2

Create and maintain architectural decision records using Markdown templates.

4|Updated Jun 10, 2026

Search Tags:#architecture #best practices #documentation #knowledge management #technical writing #adr

Ready to run

npx skills add https://github.com/mymx2/foreman --skill documentation-and-adrs-mymx2

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/mymx2/foreman/tree/main/.agents/skills/documentation-and-adrs
Command: npx skills add https://github.com/mymx2/foreman --skill documentation-and-adrs-mymx2

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill addresses the lack of context in codebases by providing a structured framework for recording architectural decisions, API specifications, and project conventions, ensuring that both human engineers and AI agents understand the rationale behind the code.

Core Features & Use Cases

Architecture Decision Records (ADRs): A standardized template for documenting significant technical choices, alternatives considered, and their long-term consequences.
Contextual Documentation: Guidelines for effective inline commenting that explains intent rather than implementation, and maintaining project READMEs.
Agent-Ready Conventions: Best practices for structuring documentation to ensure AI agents can effectively navigate and contribute to the project without repeating past mistakes.

Quick Start

Use the documentation-and-adrs skill to generate a new ADR for the proposed database migration following the project 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 to maintain project context?▼

Document architectural decisions by generating standardized Architecture Decision Records (ADRs) that capture technical choices, alternatives considered, and long-term consequences. This structured framework ensures both engineers and AI agents understand the design rationale behind the codebase.

How do I write technical documentation for AI agent-assisted development?▼

Write agent-ready technical documentation by adhering to established Markdown templates for ADRs, changelogs, and READMEs. This standardizes project conventions and structures inline comments to explain intent, helping AI agents navigate and contribute without repeating past mistakes.

What is the best way to standardize ADRs and technical writing across a repository?▼

The best way to standardize ADRs and technical writing is enforcing adherence to consistent Markdown templates for project READMEs and architectural records. This framework structures API specifications, changelogs, and project-wide conventions to improve overall maintainability.

Do I need specific templates to start recording architecture decision records?▼

Yes, you need established Markdown templates for ADRs, changelogs, and README structures to ensure documentation consistency. The skill requires adherence to these predefined formats to systematically capture design rationale and project conventions across the repository.

Why does an AI agent need structured knowledge management to understand a codebase?▼

An AI agent needs structured knowledge management to understand a codebase because it provides the necessary context regarding design rationale and API specifications. Without standardized ADRs and project conventions, AI agents lack the context to effectively navigate and contribute without repeating past mistakes.