Stats
Actions
Tags
Help us improve
Share bugs, ideas, or general feedback.
From autonomous-agent
Provides docstring templates for Python (Google style) and JavaScript (JSDoc), README structures, and standards for technical documentation. Use when generating API docs, READMEs, or updating code comments.
npx claudepluginhub bejranonda/llm-autonomous-agent-plugin-for-claude --plugin autonomous-agentHow this skill is triggered — by the user, by Claude, or both
Slash command
/autonomous-agent:documentation-best-practicesThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
This skill provides guidelines for creating high-quality documentation including docstrings, API documentation, README files, and usage guides.
Guides writing technical documentation including README files, API docs, user guides, and inline code documentation. Provides templates and best practices for clear, scannable docs.
Enforces documentation writing standards including README structure, code comments (WHY not WHAT), API documentation with types and examples, and anti-patterns like commented-out code.
Writes READMEs, API references, architecture docs, user guides, and inline comments for codebases, libraries, CLIs, APIs. Audits docs for accuracy, clarity, completeness.
Share bugs, ideas, or general feedback.
This skill provides guidelines for creating high-quality documentation including docstrings, API documentation, README files, and usage guides.
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
"""
/**
* 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
*/
Use when generating documentation, updating docstrings, creating README files, or maintaining API documentation.