documentation-pass

Generate PR narratives and add rustdoc documentation for code changes.

1|Updated Mar 30, 2022

Search Tags:#code review #documentation #maintainability #developer experience #rustdoc #pr description

Ready to run

npx skills add https://github.com/fcoury/config --skill documentation-pass

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-pass
Source: https://github.com/fcoury/config/tree/main/ai/skills/document-pass
Command: npx skills add https://github.com/fcoury/config --skill documentation-pass

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about documentation-pass

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I generate a comprehensive PR description for a complex code refactor?▼

Generating a PR description involves performing a documentation pass on recent changes. This creates a narrative covering the problem, mental model, architecture, tradeoffs, and tests, making complex refactors easier for reviewers to understand.

What is the best way to add rustdoc comments for module and type documentation?▼

Adding rustdoc comments is achieved through a non-functional documentation pass. This process adds or updates module, type, and function-level documentation to clarify design and guarantees without altering runtime behavior.

How do I surface implicit contracts and invariants in my codebase?▼

To surface implicit contracts, you perform a documentation pass. This process identifies and categorizes implicit invariants, making them explicit in the documentation to improve long-term project understanding and maintainability.

Can I improve code readability without altering runtime behavior?▼

Improving code readability without altering runtime behavior is possible through a non-functional documentation pass. This process enhances human readability by adding in-code documentation and surfacing design risks without changing functional output.

Does this documentation pass work for code review enhancement?▼

This documentation pass is primarily used for code review enhancement. It improves reviewability by generating PR narratives and adding module documentation, ensuring complex changes are clear to human reviewers and maintainers.