skills.rest
tgmarinho
tgmarinhoCOMMUNITY
Explore all skills by this author →
Website𝕏@tgmarinhoGitHub

documentation-and-adrs

Centralize project documentation and architectural decision records.

Updated Jul 2, 2026
Search Tags:#project management#documentation#codebase#decision records#architectural decisions
One-click install
npx skills add https://github.com/tgmarinho/agent-super-powers-matt-pocock-skills-comparasions --skill documentation-and-adrs-tgmarinho
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-and-adrs
Source: https://github.com/tgmarinho/agent-super-powers-matt-pocock-skills-comparasions/tree/main/upstream-snapshots/agent-skills/skills/documentation-and-adrs
Command: npx skills add https://github.com/tgmarinho/agent-super-powers-matt-pocock-skills-comparasions --skill documentation-and-adrs-tgmarinho

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the need for organized documentation and decision records within a project, ensuring that critical information is readily accessible for all stakeholders.

Core Features & Use Cases

  • ADRs for Architectural Decisions: Captures reasoning behind significant technical decisions to prevent future debates.
  • Documentation Management: Offers guidelines on when and how to document, focusing on non-obvious context and trade-offs.
  • Inline and API Documentation: Provides best practices for commenting code, writing API documentation, and structuring READMEs.
  • Agent Documentation: Special guidance for onboarding agents with clear project conventions and spec files.
  • Common Rationalizations: Debunks myths around documentation to emphasize its value.
  • Verification: Ensures that key documentation items are present and up-to-date.
  • Red Flags: Identifies issues like missing documentation and commented-out code.

Quick Start

Record a new Architecture Decision Record (ADR) in the project's 'docs/decisions/' directory, following the template provided in the SKILL.md file.

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 prevent future debates?▼

Manage project documentation by focusing on non-obvious context and trade-offs rather than obvious code mechanics. This approach ensures critical information is readily accessible, providing a comprehensive understanding of the system's rationale for new team members and stakeholders.

What are the best practices for inline comments and API documentation?▼

Use architectural decision records (ADRs) for significant technical choices and structured documentation for non-obvious context. This approach targets project stakeholders and new team members, providing a comprehensive understanding of the system's rationale and structure.

How do I structure a README and project documentation for new team members?▼

Identify documentation red flags like missing rationale, outdated specs, and commented-out code. Centralizing decision records and applying verification checks ensures key documentation items are present, up-to-date, and comprehensively structured for all project stakeholders.

When do I need architectural decision records in my codebase?▼

You need architectural decision records when making significant technical decisions that involve trade-offs. Recording these decisions in a centralized directory prevents future debates and provides critical context for new team members reviewing the codebase.

Related Skills

Explore More Software Engineering Skills→
TzuhuanhsuTzuhuanhsu

speckit-converge

Assess codebases against feature specifications and generate tasks for missing work.

Community
Advanced
zircotezircote
5

adr-compliance

Audit code against accepted ADRs and generate compliance reports.

Community
Advanced
anderson-0anderson-0
4

architecture-map

Generate Mermaid architecture diagrams from source code with dependency analysis.

Community
Advanced
tu11aatu11aa
2

wiki-ops

Create, update, and query structured wiki pages using Markdown content.

Community
Intermediate