skills.rest
ogprotege
ogprotegeCOMMUNITY
Explore all skills by this author →
𝕏@wilsonwarrenGitHub

documentation-architect

Automate technical documentation updates with drift detection and plan modes.

Updated Dec 20, 2025
Search Tags:#documentation#governance#organization#drift-detection#scope-ingest#debug-mode#plan-mode
One-click install
npx skills add https://github.com/ogprotege/Skills --skill documentation-architect-ogprotege
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-architect
Source: https://github.com/ogprotege/Skills/tree/main/Categories/Documentation/documentation-architect
Command: npx skills add https://github.com/ogprotege/Skills --skill documentation-architect-ogprotege

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps teams maintain up-to-date, accurate, and well-organized technical documentation that mirrors the current codebase, reducing confusion and onboarding time.

Core Features & Use Cases

  • Context-first documentation: Ingests a targeted scope and proposes changes before rewriting.
  • Drift detection: Catches mismatches between code and docs and guides remediation.
  • Incremental improvements: Encourages small, verifiable updates and cross-linking for discoverability.
  • Use Case: When a new microservice is added or an API surface changes, documentation-architect helps validate in-scope docs and scaffold updated material incrementally.

Quick Start

Use Documentation Architect on a service scope like /services/auth to identify drift and scaffold a plan for documentation updates.

Frequently Asked Questions about documentation-architect

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

FAQPage Schema
How do I detect when documentation drifts from code changes?▼

Drift detection automatically identifies mismatches between your codebase and technical documentation, flagging outdated content so you can remediate it systematically before confusion spreads.

Can I update documentation incrementally without disrupting the entire structure?▼

Yes. Incremental changes apply small, verifiable updates to specific scopes—directories, files, or documentation subtrees—letting you validate each change before applying it.

How do I organize and maintain documentation for a microservice architecture?▼

Define a targeted scope such as `/services/auth`, ingest the codebase context, and use plan mode to scaffold documentation updates that reflect current APIs and structure.

What's the difference between plan mode and apply mode for documentation changes?▼

Plan mode proposes documentation changes for review before rewriting; apply mode executes verified changes. This separation ensures safety and traceability in documentation evolution.

Does this work for cross-linking and discoverability across documentation subtrees?▼

Yes. The Skill supports incremental cross-linking improvements that connect related documentation sections, improving navigation and reducing duplication across your doc structure.

What happens if documentation scope is too broad or unclear?▼

Scope ingestion requires exact boundaries—directories, files, or subtrees. Overly broad scopes risk incomplete snapshots; define clear scope limits to ensure accurate, non-disruptive changes.

Related Skills

Explore More Content & Communication Skills→
agentscope-aiagentscope-ai
28.7k

Analyzing AgentScope Library

Extract signatures and documentation from AgentScope modules using Python's inspect module.

Official
Intermediate
AllBeingsFutureAllBeingsFuture
9

allbeingsfuture/skills@yuque-skills

Manage Yuque documents via API search, CRUD, publishing, export, and sync.

Community
Intermediate
dorriodorrio

ln-742-precommit-setup

Configure Husky, lint-staged, commitlint, and Python pre-commit hooks.

Community
Intermediate
loriensleafsloriensleafs

doc-sync

Synchronize CLAUDE.md navigation indexes and README.md architecture docs across a repository.

Community
Basic