skills.rest
dmarins
dmarinsCOMMUNITY
Explore all skills by this author →
GitHub

documentation-and-adrs

Standardize creation and maintenance of Architecture Decision Records and technical documentation.

Updated Apr 19, 2026
Search Tags:#architecture#documentation#adr#knowledge-management#api-design#engineering-standards
One-click install
npx skills add https://github.com/dmarins/sdd --skill documentation-and-adrs-dmarins
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/dmarins/sdd/tree/main/skills/documentation-and-adrs
Command: npx skills add https://github.com/dmarins/sdd --skill documentation-and-adrs-dmarins

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the problem of fragmented or missing technical context by providing a structured framework for recording architectural decisions (ADRs), documenting APIs, and maintaining project knowledge.

Core Features & Use Cases

  • ADR Management: Provides a standardized template and lifecycle for recording significant architectural decisions and their trade-offs.
  • Documentation Standards: Defines clear conventions for inline code documentation, API contracts (OpenAPI), and project READMEs.
  • Knowledge Preservation: Ensures that the "why" behind technical choices is captured, preventing repetitive discussions and aiding onboarding for future engineers and AI agents.

Quick Start

Use the documentation-and-adrs skill to generate a new ADR template for the proposed database migration strategy.

Frequently Asked Questions about documentation-and-adrs

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

FAQPage Schema
How do I create Architecture Decision Records to document technical choices?▼

Architecture Decision Records document technical choices by using a standardized template to capture architectural context, trade-offs, and project-wide conventions. This skill standardizes ADR creation and maintenance to preserve the reasoning behind significant engineering decisions.

What is the best way to standardize API specifications and technical documentation?▼

Standardizing API specifications and technical documentation requires defining clear conventions for inline code documentation, API contracts like OpenAPI, and project READMEs. This skill enforces these documentation standards to improve project maintainability and onboarding.

Why should I maintain architecture documentation for software projects?▼

Maintaining architecture documentation prevents fragmented technical context and repetitive discussions by capturing the "why" behind architectural decisions. This knowledge preservation aids onboarding for future engineers and agentic understanding of project conventions.

Do I need established repository conventions to manage architecture documentation?▼

Yes, managing architecture documentation requires adherence to established repository conventions for file location, naming, and formatting. This ensures the captured architectural context and API specifications integrate properly into the existing software project structure.

Can I use ADRs to document a database migration strategy?▼

Yes, you can use ADRs to document a database migration strategy by generating a standardized template for the proposed architecture. This records the significant technical decision and its trade-offs within the project's knowledge management system.

Related Skills

Explore More Software Engineering Skills→
ThrookieThrookie
2

coding-standards

Establish coding standards for TypeScript, JavaScript, React, and Node.js projects.

Community
Intermediate
slashwhyslashwhy
5

architectural-documentation

Generate templates for implementation plans, ADRs, API specifications, and migration guides.

Official
Basic
huangjunsen0406huangjunsen0406
77

trellis-check

Run linting, type-checking, and cross-layer data flow analysis before code commits.

Community
Advanced
fsollafsolla

documentation-and-adrs

Standardize architectural decision records and technical documentation in markdown.

Community
Intermediate