documentation-finalization

Name: documentation-finalization
Availability: InStock
Author: grimblaz

Align repository documentation with the implemented state and remove obsolete content.

3|Updated Dec 7, 2025

Search Tags:#documentation #finalization #markdownlint #terminology #cross-references #design-docs #domain-docs

Ready to run

npx skills add https://github.com/Grimblaz/agent-orchestra --skill documentation-finalization

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: documentation-finalization
Source: https://github.com/Grimblaz/agent-orchestra/tree/main/skills/documentation-finalization
Command: npx skills add https://github.com/Grimblaz/agent-orchestra --skill documentation-finalization

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation frequently drifts from the implemented state; this skill provides a formal finalization workflow to align docs with implementation, remove obsolete content, and ensure accuracy.

Core Features & Use Cases

Updates Development Docs, Design Docs, Decision Docs, and Domain Design Docs to reflect current state.
Removes placeholders and stale guidance; maintains cross-reference integrity.
Supports a repeatable finalization checklist for releases and design iterations.

Quick Start

Update all affected documents to reflect the current implementation state and remove obsolete content.

Frequently Asked Questions about documentation-finalization

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

FAQPage Schema

How do I finalize documentation to match my shipped implementation?▼

To finalize documentation against shipped behavior, you update Development Docs, Design Docs, and Domain Design Docs by validating terminology, fixing cross-references, and removing obsolete placeholders to ensure accuracy.

What is the best way to update design docs and remove placeholders before a release?▼

Updating design docs before a release involves applying a finalization checklist to remove placeholders, enforce terminology consistency, and validate cross-reference integrity against the current implementation state.

How do I maintain terminology consistency and cross-reference integrity in domain docs?▼

Maintaining terminology consistency and cross-reference integrity in domain docs requires validating document contents against the current implementation to align definitions and remove broken links.

When do I need to finalize decision docs and development docs?▼

You need to finalize decision docs and development docs when your implementation reaches a shipped state, ensuring the recorded decisions and guidance accurately reflect the final product behavior.

Can I automate obsolete content removal from markdown documentation?▼

Yes, you can automate obsolete content removal by applying a formal finalization workflow that validates markdown documents against the implementation and strips out stale guidance automatically.

Does documentation finalization work with markdownlint for terminology enforcement?▼

Documentation finalization works alongside markdownlint to enforce terminology consistency, using the finalization workflow to align content and the linter to validate markdown formatting rules.