What documentation style does this skill prefer?

This skill defaults to the Google Python Style Guide for docstrings, emphasizing clarity, type hinting, and consistent usage examples.

Does it support API documentation frameworks?

Absolutely. It provides specific patterns for documenting FastAPI and OpenAPI endpoints, including Pydantic model descriptions and status code explanations.

Can this skill help me track architectural changes?

Yes, it includes a standardized framework for Architecture Decision Records (ADRs) to document the context, decisions, and consequences of technical shifts.

How does this skill handle inline comments?

It follows the 'document why, not what' philosophy, focusing on clarifying non-obvious behavior, workarounds, and business rules rather than restating the code.

Code Documentation Assistant

Name: Code Documentation Assistant
Author: btimothy-har

bybtimothy-har

0•

학습 및 문서화

Generates and improves high-quality code documentation including Google-style docstrings, READMEs, and Architecture Decision Records.

The Code Documentation skill transforms Claude into a specialized technical writer, ensuring your codebase remains maintainable, professional, and easy to navigate. It enforces industry best practices such as explaining the 'why' behind logic rather than just the 'what,' keeping documentation close to the code, and maintaining audience awareness. Whether you need to generate standardized Google-style Python docstrings, record significant technical trade-offs via Architecture Decision Records (ADRs), or build comprehensive project READMEs, this skill provides the structure and clarity required for high-performing engineering teams.

주요 기능

01Standardized Changelog management grouped by feature type (Added, Fixed, Security).

02Context-aware inline comment optimization focusing on complex logic and workarounds.

03Automated Architecture Decision Record (ADR) templates for tracking technical history.

04Standardized Google-style docstring generation for Python functions, classes, and modules.

05Comprehensive README structure including Quick Start, Installation, and Usage guides.

060 GitHub stars

사용 사례

01Ensuring API consistency by generating detailed endpoint documentation and OpenAPI schemas.

02Modernizing a legacy codebase by adding missing documentation to public APIs and complex algorithms.

03Onboarding new developers faster by creating clear, copy-pasteable README guides and ADRs.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add btimothy-har/basecamp code-documentation

For use in Claude.ai and ChatGPT

주요 기능

01Standardized Changelog management grouped by feature type (Added, Fixed, Security).

02Context-aware inline comment optimization focusing on complex logic and workarounds.

03Automated Architecture Decision Record (ADR) templates for tracking technical history.

04Standardized Google-style docstring generation for Python functions, classes, and modules.

05Comprehensive README structure including Quick Start, Installation, and Usage guides.

060 GitHub stars

사용 사례

01Ensuring API consistency by generating detailed endpoint documentation and OpenAPI schemas.

02Modernizing a legacy codebase by adding missing documentation to public APIs and complex algorithms.

03Onboarding new developers faster by creating clear, copy-pasteable README guides and ADRs.