documentation-maintenance

Audit project documentation against recent code changes before pull requests.

3|Updated Jan 31, 2025
One-click install
npx skills add https://github.com/Cantara/lib-electronic-components --skill documentation-maintenance
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-maintenance
Source: https://github.com/Cantara/lib-electronic-components/tree/main/.claude/skills/documentation-maintenance
Command: npx skills add https://github.com/Cantara/lib-electronic-components --skill documentation-maintenance

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that all project documentation, including skill descriptions and learnings, is kept up-to-date with code changes, preventing knowledge gaps and outdated information.

Core Features & Use Cases

  • Pre-PR Documentation Audit: Guides users through a checklist to ensure all relevant documentation is updated before submitting a pull request.
  • Targeted Documentation Updates: Provides specific guidance on where to document learnings based on the type of code change.
  • Use Case: Before creating a pull request for a new feature that modifies component type detection, you would run this skill to ensure the /component-type-detection-hierarchy/SKILL.md file is updated with the new logic and any relevant examples.

Quick Start

Run the documentation maintenance skill before creating a pull request.

Frequently Asked Questions about documentation-maintenance

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

FAQPage Schema
How do I keep documentation in sync with code changes before a pull request?

To keep documentation in sync with code changes, run a pre-PR documentation audit using a checklist to verify project files, skill files, and CLAUDE.md reflect recent features and architectural modifications. This prevents outdated information and knowledge gaps.

What is documentation drift and how do I prevent it?

Documentation drift occurs when project docs become outdated relative to code. Prevent drift by integrating maintenance checklists into commit and PR workflows, ensuring new features, bug fixes, and architectural changes are documented immediately during development.

How do I update CLAUDE.md and skill files after modifying code?

Update CLAUDE.md and skill files by following targeted documentation guidance based on the specific code change type. This ensures learnings and architectural modifications are recorded in the correct files, preserving institutional knowledge across the project.

When should I perform a documentation maintenance check in my workflow?

Perform a documentation maintenance check before creating a pull request. Running this pre-PR audit ensures all relevant files are updated with new logic and examples, enforcing documentation standards and preventing knowledge loss during code reviews.

Can I enforce documentation standards within my commit and PR workflows?

Yes, you can enforce documentation standards by integrating maintenance checklists into commit and PR workflows. This guides users to document new features and bug fixes before submission, ensuring project documentation remains current and accurate.