documentation
Documentation Skill
Automated documentation generation and management guidelines.
When to Apply
Use these guidelines when:
- Creating new documentation
- Updating existing docs
- Documenting APIs
- Adding inline comments
- Maintaining README files
Documentation Types
1. README Files
Every project should have a README.md with:
- Project title and description
More from uwe-schwarz/skills
github-pr-review-workflow
Complete workflow for handling GitHub PR reviews using gh pr-review extension
40upgrade-dependencies-pr
Update a JavaScript, TypeScript, or Python project's dependencies to the latest published versions, remove exact pinned JS semver specs when appropriate, convert stray JS `latest` tags back to explicit semver ranges, evaluate release impact against the codebase and official release notes, identify newly introduced features and enforcement changes, apply required small upgrade fixes, open GitHub issues for larger or optional follow-up work, and finish by creating a branch, commit, push, and PR. Use when asked to upgrade dependencies, refresh packages, unpin dependency versions, or ship an end-to-end dependency maintenance PR.
12coderabbit-review
Perform code review using CodeRabbit. Must use this skill if instructed to perform a CodeRabbit review.
9example-skill
An example skill demonstrating the Agent Skills format. Use this as a template for creating your own skills.
8your-skill-name
A clear description of what this skill does and when to use it. This should be comprehensive so agents understand when to activate this skill.
8code-review
Comprehensive code review guidelines for ensuring code quality, security, and maintainability. Use when reviewing pull requests, refactoring code, or ensuring best practices.
8