skills.rest
tipmaster
tipmasterCOMMUNITY
Explore all skills by this author →
GitHub

documentation-completeness

Review pull requests for updated README, API docs, and changelog.

Updated Aug 23, 2026
Search Tags:#changelog#documentation#onboarding#knowledge management#readme#code comments#api docs
One-click install
npx skills add https://github.com/tipmaster/claude-config --skill documentation-completeness
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-completeness
Source: https://github.com/tipmaster/claude-config/tree/main/skills/documentation-completeness
Command: npx skills add https://github.com/tipmaster/claude-config --skill documentation-completeness

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that code changes are always accompanied by relevant documentation updates, preventing outdated information, reducing onboarding friction for new team members, and preserving critical institutional knowledge.

Core Features & Use Cases

  • README Updates: Guides updating installation, usage, configuration, and examples in the project's README.md.
  • Code Comments: Advises on when and what to comment, focusing on why and complex logic rather than what.
  • API & Changelog Sync: Ensures API documentation (OpenAPI/JSDoc) and user-facing CHANGELOG.md are current.
  • Use Case: After implementing a new feature, use this skill to ensure the README.md is updated, relevant code comments are added, the API documentation reflects new endpoints, and the CHANGELOG.md includes the user-facing changes.

Quick Start

Use the documentation-completeness skill to review my pull request for a new feature, ensuring all relevant documentation (README, API docs, comments) has been updated.