What is an Architecture Decision Record (ADR)?

An ADR is a short text file that captures a significant architectural decision, including its context, rationale, and consequences for future reference.

What documentation formats are supported?

This skill supports Markdown for READMEs and ADRs, JSDoc/TSDoc for inline code documentation, and YAML for OpenAPI/Swagger API specifications.

Does it support scientific or mathematical documentation?

Yes, it includes specific interleaving for scientific skills like Graph Theory (networkx) and category theory (Cat#) equipment structures.

How does this skill improve inline comments?

It implements logic to focus comments on 'why' a decision was made rather than 'what' the code is doing, avoiding redundant or obvious descriptions.

Code Documentation Architect

Name: Code Documentation Architect
Author: plurigrid

byplurigrid

•

学习与文档

Standardizes and automates the creation of professional READMEs, API references, and architectural records.

The Code Documentation skill empowers Claude to generate comprehensive, high-quality documentation that bridges the gap between raw code and developer understanding. It provides structured templates for standard READMEs, enforces industry-best JSDoc/TSDoc and OpenAPI specifications, and guides the creation of Architecture Decision Records (ADRs). By emphasizing 'why' over 'what' in inline comments and promoting progressive disclosure, this skill ensures your project's documentation remains maintainable, professional, and accessible to both new contributors and API consumers.

主要功能

01Architecture Decision Record (ADR) templates for tracking technical trade-offs

02Automated JSDoc and TSDoc generation for TypeScript and JavaScript

03OpenAPI/Swagger schema definition for RESTful API services

048 GitHub stars

05Standardized README templates with installation, usage, and API sections

06Heuristics for effective inline commenting and complex logic explanation

使用场景

01Generate comprehensive API documentation for complex TypeScript modules

02Document critical architectural shifts using the ADR format to maintain team alignment

03Bootstrap a professional README for a new open-source project or private repository

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add plurigrid/asi code-documentation

For use in Claude.ai and ChatGPT

Download Skill