How does the skill know when to update documentation?

It uses auto-activation rules based on keywords like 'docs' or 'api' and detects code changes that impact features, dependencies, or breaking changes.

Does it support standard versioning practices?

Yes, it enforces Semantic Versioning (SemVer) and follows the 'Keep a Changelog' format for professional history tracking.

Can it help with architectural decisions?

Absolutely. It includes a specific template for Architecture Decision Records (ADRs) to document the context, consequences, and alternatives for major technical choices.

Does this work with local AI models?

Yes, it is part of the anyclaude-local repository, which is specifically optimized for use with local instances like LM Studio.

Documentation Strategy & Automation

Name: Documentation Strategy & Automation
Author: akaszubski

byakaszubski

•

学习与文档

Automates the creation and maintenance of project documentation to ensure synchronization between code changes and guides.

关于

Documentation Strategy & Automation is a comprehensive skill designed to maintain project alignment by automatically identifying when code changes require documentation updates. It provides standardized templates for READMEs, CHANGELOGs, API references, and Architecture Decision Records (ADRs), while enforcing consistent writing styles and automated link validation. This skill is essential for maintaining professional-grade documentation in fast-moving development environments, ensuring that tutorials and guides stay accurate as the codebase evolves.

主要功能

Standardized templates for Architecture Decision Records (ADRs)
Automated update rules for README, CHANGELOG, and API docs
Docstring extraction for automated API reference generation
Internal link validation and broken link detection
Semantic versioning and 'Keep a Changelog' format enforcement
2 GitHub stars

使用场景

Generating professional API documentation directly from Python docstrings
Documenting complex architectural decisions using standardized ADR templates
Ensuring the CHANGELOG is updated automatically with every pull request

关于

主要功能

Standardized templates for Architecture Decision Records (ADRs)
Automated update rules for README, CHANGELOG, and API docs
Docstring extraction for automated API reference generation
Internal link validation and broken link detection
Semantic versioning and 'Keep a Changelog' format enforcement
2 GitHub stars

使用场景

Generating professional API documentation directly from Python docstrings
Documenting complex architectural decisions using standardized ADR templates
Ensuring the CHANGELOG is updated automatically with every pull request