documentation-pass
CommunityEnhance code clarity and reviewability.
Software Engineering#code review#documentation#maintainability#developer experience#rustdoc#pr description
Authorfcoury
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of making complex code changes understandable to human reviewers and maintainers, ensuring clarity without altering runtime behavior.
Core Features & Use Cases
- PR Narrative Generation: Creates a comprehensive PR description covering problem, mental model, non-goals, tradeoffs, architecture, observability, and tests.
- In-Code Documentation: Adds or updates module, type, and function-level documentation, especially for Rust code (rustdoc).
- Contract Explicitness: Surfaces implicit contracts and invariants, categorizing them for better documentation.
- Use Case: After a significant refactor, use this Skill to generate a clear PR description and add necessary rustdoc comments to explain the new design and its guarantees.
Quick Start
Use the documentation-pass skill to generate a PR description and add rustdoc comments for the recent changes in the src/ directory.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documentation-pass Download link: https://github.com/fcoury/config/archive/main.zip#documentation-pass Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.