🎯

documentation-best-practices

🎯Skill

from bejranonda/llm-autonomous-agent-plugin-for-claude

What it does

Provides actionable templates and standards for creating comprehensive, clear technical documentation across programming languages and project types.

📦

Part of

bejranonda/llm-autonomous-agent-plugin-for-claude(25 items)

documentation-best-practices

Installation

PythonRun Python server

python lib/web_page_validator.py http://localhost:3000 --screenshot

PythonRun Python server

python lib/web_page_validator.py http://localhost:3000/dashboard \

PythonRun Python server

python lib/web_page_validator.py http://localhost:3000 --viewport all --screenshot

Install PluginInstall plugin from marketplace

/plugin install https://github.com/bejranonda/LLM-Autonomous-Agent-Plugin-for-Claude

Claude CodeAdd plugin in Claude Code

/plugin list

+ 2 more commands

📖 Extracted from docs: bejranonda/llm-autonomous-agent-plugin-for-claude

Need more details? View full documentation on GitHub →

2Installs

AddedFeb 4, 2026

View on GitHub Back to Skills

Skill Details

SKILL.md

Provides templates, standards, and best practices for writing clear, comprehensive technical documentation

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)

```python

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)

```javascript

/**

* 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 from this repository10

🏪

bejranonda-llm-autonomous-agent-plugin-for-claude🏪Marketplace

Premium marketplace for revolutionary autonomous AI agents featuring four-tier architecture, intelligent pattern learning, comprehensive quality control, and full-stack validation with 80-90% auto-fix success rates.

🎯

web-validation🎯Skill

Validates web applications by detecting JavaScript errors, capturing screenshots, testing authentication flows, and monitoring browser console across multiple device viewports.

🎯

frontend-aesthetics🎯Skill

Guides frontend design to create distinctive, polished interfaces by avoiding generic AI defaults and implementing thoughtful typography, color, and animation principles.

🎯

group-collaboration🎯Skill

Facilitates collaborative group interactions by enabling Claude to coordinate tasks, assign roles, and manage team communication effectively.

🎯

web-artifacts-builder🎯Skill

Builds production-ready web applications using React, Tailwind CSS, and shadcn/ui with a focus on type safety, accessibility, and performance.

🎯

code-analysis🎯Skill

Analyzes code complexity, detects anti-patterns, and provides actionable refactoring strategies across multiple programming languages.

🎯

web-search-fallback🎯Skill

Enables reliable web searching by using an autonomous agent as a fallback when standard WebSearch encounters errors or limitations.

🎯

predictive-skill-loading🎯Skill

Predicts and dynamically loads relevant skills for Claude based on context and task requirements to enhance autonomous agent capabilities.

🎯

quality-standards🎯Skill

Enforces comprehensive code quality standards, metrics, and best practices across multiple programming languages.

🎯

claude-plugin-validation🎯Skill

Validates Claude Code plugin manifests and structures to ensure guideline compliance, prevent installation failures, and maintain compatibility.