update-docs

Audit and update project documentation to align with recent code modifications.

34|9|Updated Mar 12, 2026
One-click install
npx skills add https://github.com/gitlabhq/orbit-knowledge-graph --skill update-docs-gitlabhq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/gitlabhq/orbit-knowledge-graph/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/gitlabhq/orbit-knowledge-graph --skill update-docs-gitlabhq

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the common issue of documentation becoming outdated as code evolves, ensuring that architectural descriptions, API details, and behavioral explanations accurately reflect the current state of the project.

Core Features & Use Cases

  • Documentation Auditing: Compares code changes against existing documentation to identify discrepancies.
  • Targeted Updates: Focuses on updating specific sections like ontology definitions, query engine documentation, indexing details, security models, and agent contexts.
  • Use Case: After a significant refactor of the query engine, this Skill can be used to audit docs/querying/graph_engine.md and update it to reflect the new API endpoints and data structures.

Quick Start

Audit and update documentation after code changes to ensure accuracy.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep documentation in sync with code changes after a major refactor?

To keep documentation in sync with code changes, you can audit project files against recent modifications. This process identifies discrepancies in architectural descriptions, API details, and behavioral explanations to ensure accuracy.

What is the best way to update technical writing for API and behavioral changes?

The best way to update technical writing for API and behavioral changes is through targeted documentation auditing. This approach compares code modifications against existing docs to pinpoint sections needing revision.

Do I need glab to audit and update project documentation?

Yes, you need glab along with Git and internal linting tools. These dependencies are required for validation, context gathering, and accessing repository data to update project documentation.

Can I use this approach to update ontology definitions and security models?

Yes, you can use this approach to update ontology definitions and security models. It targets specific documentation sections including indexing procedures, query engine specifics, and agent contexts.

How does documentation auditing work for maintaining a knowledge graph?

Documentation auditing for maintaining a knowledge graph works by comparing recent code modifications against existing docs. It identifies discrepancies in architectural explanations to ensure consistency in ontology definitions.

When should I not use automated code sync for technical writing?

You should not use automated code sync for technical writing when modifications are purely cosmetic. It is designed for auditing architectural, API, and behavioral changes rather than minor syntactical updates.