Menu
Provides templates, standards, and best practices for writing clear, comprehensive technical documentation
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
Based on SOC occupation classification
| name | documentation-best-practices |
| description | Provides templates, standards, and best practices for writing clear, comprehensive technical documentation |
| version | 1.0.0 |
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.
Advanced knowledge and methodologies for implementing next-generation AGI capabilities with quantum computing, neural evolution, and dimensional computing
Decision-making methodologies, scoring frameworks, and planning strategies for Group 2 agents in four-tier architecture
Best practices for inter-group communication, knowledge sharing, and collaborative workflows in four-tier architecture
Detailed implementation strategies for the four-tier orchestrator agent architecture including sub-agent definitions and group coordination protocols.
Autonomous agent-based web search fallback for when WebSearch API fails or hits limits
Comprehensive web page validation with authentication, screenshot capture, mobile testing, and enhanced error detection