What style of docstrings does this skill support?

The skill primarily follows the Google style for Python docstrings, which includes specific sections for Arguments, Returns, Raises, and Usage Examples.

Can it generate API documentation for web frameworks?

Yes, it provides specific patterns for documenting FastAPI endpoints, Pydantic models, and OpenAPI enhancements to ensure clear contract definitions.

Does this skill help with inline commenting?

Yes, it enforces the philosophy of 'documenting the why, not the what,' helping developers avoid redundant comments while highlighting non-obvious logic or workarounds.

How does this skill help with long-term project maintenance?

It implements Architecture Decision Records (ADRs) to document the reasoning behind technical choices, ensuring future maintainers understand the context of the current architecture.

Code Documentation & Standards

Name: Code Documentation & Standards
Author: btimothy-har

bybtimothy-har

内容管理

Standardizes technical documentation including docstrings, READMEs, and architecture decisions to improve code maintainability.

关于

This skill empowers Claude to generate and maintain high-quality software documentation following industry best practices. It provides structured patterns for Google-style Python docstrings, comprehensive README files, Architecture Decision Records (ADRs), and clear inline comments. By focusing on the 'why' rather than just the 'what,' it ensures that codebase knowledge is preserved, APIs are well-defined, and future developers can quickly understand complex logic, trade-offs, and implementation details.

主要功能

Comprehensive README templates for project onboarding
0 GitHub stars
API and OpenAPI documentation patterns for backend services
Architecture Decision Record (ADR) framework for tracking technical choices
Standardized Google-style Python docstring generation
Standardized changelog management for clear version history

使用场景

Documenting a new Python library with consistent docstrings and usage examples
Creating an ADR to justify and record major technical architecture shifts
Generating a high-quality README for a repository to accelerate developer setup

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add btimothy-har/bworkspace code-documentation

For use in Claude.ai and ChatGPT

Download Skill

GitHub

关于