skills.rest
mhamzahashim
mhamzahashimCOMMUNITY
Explore all skills by this author →
Website𝕏@mhamza_hashimGitHub

doc-maintenance

Audit top-level documentation for drift and open Pull Requests with proposed edits.

Updated Mar 28, 2026
Search Tags:#documentation#audit#update#Pull Request#codebase synchronization
One-click install
npx skills add https://github.com/mhamzahashim/paperclip --skill doc-maintenance-mhamzahashim
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-maintenance
Source: https://github.com/mhamzahashim/paperclip/tree/main/.agents/skills/doc-maintenance
Command: npx skills add https://github.com/mhamzahashim/paperclip --skill doc-maintenance-mhamzahashim

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the process of reviewing and updating top-level documentation to ensure it accurately reflects the latest features and changes in the codebase.

Core Features & Use Cases

  • Audit Documentation: Scans documentation for drift from recent code changes.
  • Propose Edits: Suggests minimal edits to correct inaccuracies and updates features.
  • Automated Branching and PR: Creates a branch and opens a Pull Request with the suggested changes.
  • Use Case: After a major feature merge, use this Skill to automatically review and update the README, SPEC, and PRODUCT documentation.

Quick Start

Run the doc-maintenance skill to automatically audit and update the documentation.

Frequently Asked Questions about doc-maintenance

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

FAQPage Schema
How do I automate documentation updates after merging code changes?▼

Automating documentation updates involves auditing top-level docs for drift from recent codebase changes, proposing minimal edits to fix inaccuracies, creating a branch, and opening a Pull Request with the suggested updates.

What is documentation drift and how do I detect it in my repository?▼

Documentation drift occurs when top-level files like README or SPEC no longer reflect the latest features. You can detect drift by automatically comparing recent commit history against existing documentation to identify outdated sections.

Can I automatically create a Pull Request for README and SPEC updates?▼

Yes, you can automatically create a Pull Request for README and SPEC updates. The process proposes necessary edits, creates a dedicated branch, and opens a Pull Request containing the documentation corrections for review.

Do I need write access to the repository to audit and update documentation?▼

Yes, you need write access to the repository and access to its commit history. These permissions are required to scan recent changes, create a branch, and open a Pull Request with proposed documentation updates.

When should I run a documentation audit for codebase synchronization?▼

You should run a documentation audit for codebase synchronization after a major feature merge. This ensures top-level PRODUCT, SPEC, and README documentation accurately matches the latest functionality added to the codebase.

Related Skills

Explore More Software Engineering Skills→
Kushal9889Kushal9889

create-pr

Create a branch, commit changes, and open a pull request via GitHub API.

Community
Advanced
khoabdkhoabd

doc-maintenance

Detect documentation drift and generate minimal factual edits via pull requests.

Community
Intermediate
jkitchinjkitchin
34

python-regression-statistics

Guide regression analysis and outlier detection in Python using statsmodels, scikit-learn, scipy, and PyOD.

Community
Advanced
ajsai47ajsai47
11

review

Analyze git diffs for SQL injection, race conditions, and shell injection risks.

Community
Advanced