Documentation And Adrs

Documentation And Adrs

addyosmani

Documentation And Adrs

Documentation And Adrs

Guide your project's technical documentation, architecture decision records, inline comments, and API schemas.

New tool
0 downloads
Free

About

Documentation and ADRs guides agents and engineers through recording the reasoning behind technical decisions, architecture choices, and public API designs. It details when and how to write Architecture Decision Records, structure inline comments that explain intent rather than restating code, document APIs with types or OpenAPI specs, and maintain project READMEs and changelogs. Reach for this skill when you need to establish project context, record constraints and trade-offs, and prevent future engineers or AI agents from rehashing past design choices.

Key Features

Architecture Decision Record (ADR) templates and lifecycle guidance
Inline comment best practices focusing on intent over repetition
Public API documentation standards for TypeScript and OpenAPI
Project README and changelog maintenance templates

Privacy & Security

Data Collection

This tool follows industry-standard security practices and only collects data necessary for functionality.

Information

Developeraddyosmani
Version1.0.0
Ratingeveryone
LanguagesEnglish

Actions

  • Write an architecture decision record
  • Document inline code intent
  • Write public API documentation
  • Structure a project readme
  • Maintain a project changelog