document-code

Solid

Apply Google Style documentation standards to Python, Go, TypeScript, and Terraform code. Use when writing or reviewing code that needs docstrings/comments/JSDoc, when asked to "document this code", "add docstrings", "follow Google Style", or when improving code documentation quality. Supports Python docstrings, Go comments, TypeScript JSDoc, and Terraform variable/output descriptions. Enforces consistent, professional documentation standards.

Data & Documents 48 stars 4 forks Updated today MIT

Install

View on GitHub

Quality Score: 84/100

Stars 20%
56
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Code Documentation Standards Apply Google Style documentation standards to Python (docstrings), Go (comments), TypeScript (JSDoc), and Terraform (descriptions). Ensures consistent, professional, and comprehensive code documentation across multiple languages. ## When to Apply This Skill Use this skill when: - Writing new functions, classes, or packages - Reviewing code for documentation quality - User requests "document this code" or "add docstrings" - User mentions "Google Style" or documentation standards - Refactoring code that lacks proper documentation - Creating code examples that should be well-documented ## Core Principles 1. **Clarity**: Documentation should be immediately understandable 2. **Completeness**: Document all public APIs, parameters, returns, exceptions 3. **Consistency**: Follow language-specific Google Style conventions 4. **Conciseness**: Be thorough but avoid redundancy 5. **Examples**: Include usage examples for complex functionality ## Workflow ### 1. Detect Language Identify the programming language: - **Python**: Look for `.py` files, `def`, `class` keywords, type hints - **Go**: Look for `.go` files, `func`, `type`, `package` keywords - **TypeScript**: Look for `.ts` / `.tsx` files, `interface`, `type`, `export`, `import` keywords - **Terraform**: Look for `.tf` files, `resource`, `variable`, `module` keywords ### 2. Apply Appropriate Standard Read the corresponding reference file: - **Python**: Read `references/python_google_style....

Details

Author
jjmartres
Repository
jjmartres/ai-coding-agents
Created
5 months ago
Last Updated
today
Language
TypeScript
License
MIT

Integrates with

Similar Skills

Semantically similar based on skill content — not just same category