documentation-guide

What problem does it solve?

Keeping documentation up-to-date with rapidly changing code is a constant struggle, leading to outdated guides and frustrated users. This Skill provides a comprehensive framework for documentation standards and automation, ensuring your project's docs are always accurate, consistent, and easy to navigate.

Core Features & Use Cases

• Structured Documentation: Defines a clear directory structure for guides, API references, examples, and architectural decisions.
• Auto-Update Rules: Specifies when and how to update various documentation sections (e.g., CHANGELOG.md, README.md, API docs) based on code changes.
• Writing Standards & Templates: Provides templates for consistent tone, style, and content, including Google-style docstrings and ADRs.
• Use Case: After implementing a new feature, this Skill guides you through updating the CHANGELOG.md, creating a new feature guide, and ensuring API documentation is auto-generated from your Python docstrings, all while validating internal links.

Quick Start

Always update CHANGELOG.md for every change.

Example CHANGELOG entry:

## [Unreleased]

### Added

- New feature X with Y capability

Use Google-style docstrings for functions:

def train_model(data: List[Dict]) -> TrainResult:

"""Train model on provided data.

Args:

data: Training data

Returns:

TrainResult

"""