Code Documentation

•
3.1k
•

Writes clear, user-centric code documentation and docstrings across Dart, Python, and TypeScript to maximize API usability and maintainability.

The Code Documentation skill guides Claude in crafting concise, professional, and user-centric documentation comments, docstrings, and implementation notes. Optimized for multi-language projects with dedicated conventions for Dart/Flutter, TypeScript, and Python, it enforces standard structural rules—such as single-sentence summaries, third-person verbs, and practical code examples—while eliminating redundant filler phrases. It helps engineering teams maintain clean public APIs, clarify complex architectural decisions, and elevate developer onboarding through standardized, high-quality code commentary.

Características Principales

01Clear separation between external API documentation and internal implementation comments
02Built-in documentation review checklist to verify completeness and parameter coverage
03Language-specific conventions for Dart (dartdoc), TypeScript (JSDoc), and Python docstrings
043,092 GitHub stars
05Style enforcement that strips filler phrases and mandates active, third-person verbs
06Standard comment structuring featuring one-sentence summaries, blank separators, and usage notes

Casos de Uso

01Adding illustrative code examples and edge-case warnings to complex functions and classes
02Documenting public APIs, SDKs, and libraries for external and internal consumer integration
03Refactoring legacy or missing docstrings across Dart, Flutter, TypeScript, or Python codebases