documentation skill

Generate Google-style docstrings and README sections for code modules.

Updated Oct 23, 2025

Search Tags:#automation #documentation #markdown #readme #docstrings #code #coding-standards

One-click install

npx skills add https://github.com/ApexSigma-Solutions/omega_kg --skill documentation-skill-apexsigma-solutions

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: documentation skill
Source: https://github.com/ApexSigma-Solutions/omega_kg/tree/main/.factory/Skills/documentation
Command: npx skills add https://github.com/ApexSigma-Solutions/omega_kg --skill documentation-skill-apexsigma-solutions

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the generation of high-quality code documentation, including inline docstrings, type hints, and README sections, so your codebase stays understandable and maintainable without manual toil.

Core Features & Use Cases

Inline Docstrings & Comments: Generate Google-style docstrings for functions, classes, and modules.
README & Documentation Bundles: Create or update README content, API docs, and usage examples.
Style Consistency & Review: Enforce a uniform documentation style across the project.
Use Case: When onboarding a new feature, run this Skill to produce consistent, publish-ready documentation.

Quick Start

In the attached codebase, request documentation for the module user_service.py, and the Skill will generate Google-style docstrings and update relevant README sections.