Delegate independent tasks to specialized agents working concurrently with isolated context.
Documentation Best Practices
documentation-best-practices
Provides templates, standards, and best practices for writing clear, comprehensive technical documentation
SKILL.md
Full skill instructions
Overview
This skill provides guidelines for creating high-quality documentation including docstrings, API documentation, README files, and usage guides.
Documentation Coverage Targets
- Public APIs: 100% documented
- Internal Functions: 80%+ documented
- Complex Logic: Must have explanation comments
- Overall: 85%+ coverage
Docstring Templates
Python (Google Style)
def function_name(param1: str, param2: int) -> bool:
"""Brief one-line description.
Longer detailed explanation if needed.
Args:
param1: Description of param1
param2: Description of param2
Returns:
Description of return value
Raises:
ValueError: When and why
"""
JavaScript (JSDoc)
/**
* Brief one-line description.
*
* @param {string} param1 - Description of param1
* @param {number} param2 - Description of param2
* @returns {boolean} Description of return value
* @throws {Error} When and why
*/
README Structure
- Project Title & Description
- Installation: Step-by-step setup
- Usage: Basic examples
- API Documentation: Overview or link
- Contributing: Guidelines (if applicable)
- License: Project license
When to Apply
Use when generating documentation, updating docstrings, creating README files, or maintaining API documentation.
More Other skills
brand-guidelines
Applies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.
theme-factory
Toolkit for styling artifacts with a theme. These artifacts can be slides, docs, reportings, HTML landing pages, etc. There are 10 pre-set themes with colors/fonts that you can apply to any artifact that has been creating, or can generate a new theme on-the-fly.
internal-comms
A set of resources to help me write all kinds of internal communications, using the formats that my company likes to use. Claude should use this skill whenever asked to write some sort of internal communications (status reports, leadership updates, 3P updates, company newsletters, FAQs, incident reports, project updates, etc.).
Fundamental design principles for writing maintainable, testable Python code.
responsive-design
Modern responsive layouts using container queries, fluid typography, CSS Grid, and mobile-first strategies.
Generate Playwright tests from scenarios using interactive browser exploration and validation.
Automated website exploration and test case generation using Playwright.
Modern React state management with Redux Toolkit, Zustand, Jotai, and React Query for every state category.
gdpr-data-handling
GDPR-compliant data handling with consent management, data subject rights, and privacy controls.
Python error handling patterns including input validation, exception hierarchies, and partial failure handling. Use when implementing validation logic, designing exception strategies, handling batch processing failures, or building robust APIs.
refactor-plan
Detailed multi-file refactor planning with safety checks and rollback guidance.
