update-project-documentation

Updates existing documentation to match source code changes through delta analysis and surgical edits.

37|4|Updated Apr 11, 2026
One-click install
npx skills add https://github.com/jmrplens/gitlab-mcp-server --skill update-project-documentation-jmrplens
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-project-documentation
Source: https://github.com/jmrplens/gitlab-mcp-server/tree/main/.github/skills/update-project-documentation
Command: npx skills add https://github.com/jmrplens/gitlab-mcp-server --skill update-project-documentation-jmrplens

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Code changes constantly drift out of sync with project documentation, leaving reference docs, API tables, and architecture diagrams stale. This Skill analyzes code diffs, maps them to affected documents, and applies targeted updates without rewriting entire files. ## Core Features & Use Cases - Delta Analysis: Scans git diffs and Go source files to identify new, modified, or removed exported types, functions, tools, and configuration options. - Change-to-Document Mapping: Routes each change type (new MCP tool, config change, architecture change) to the specific documentation file that owns it. - Surgical Updates with Verification: Preserves document structure and style, updates tables and Mermaid diagrams, then runs a parity checklist confirming examples, links, and terminology match the source. - Use Case: After adding a new MCP tool to a GitLab server, run this Skill to update the owning tools reference page, regenerate catalog tables, and verify cross-references still resolve. ## Quick Start Update the project documentation to reflect the code changes in my latest commit.

Frequently Asked Questions about update-project-documentation

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

FAQPage Schema
How do I keep documentation in sync with code changes?

Run a delta analysis comparing recent code changes against existing docs, then update only the affected sections. This Skill maps each change type, such as new APIs or config options, to the specific document that owns it and verifies parity afterward.

How to update API documentation after changing function signatures?

Modified signatures require updating parameter tables, return type docs, and code examples in the affected reference pages. Breaking changes should also include migration notes, and removed APIs get deprecation notices before full removal after one release cycle.

Does this work with generated documentation content?

Generator-owned content such as catalog tables, benchmark charts, and stats blocks is never hand-edited. The Skill runs the project's generators instead, for example via make update-all, and only manually edits human-owned sections.

What happens if a documentation file is missing?

When an expected documentation file is not found, the Skill reports the missing path and recommends running the documentation generation skill first rather than creating unstructured replacements.

Can it update Mermaid diagrams after architecture changes?

Yes, architecture and component relationship changes trigger updates to Mermaid diagrams in the relevant docs. If diagram rendering fails, the Skill provides the Mermaid source and flags it for manual validation.