docs

Update USER_GUIDE.md and README.md to reflect actual feature behavior.

1|Updated Apr 23, 2026

Search Tags:#documentation #diataxis #user-guide #living-docs #content-pruning #revision-workflow

Ready to run

npx skills add https://github.com/hdtinh57/codex-orchestrated-project-template --skill docs-hdtinh57

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/hdtinh57/codex-orchestrated-project-template/tree/main/.codex/skills/docs
Command: npx skills add https://github.com/hdtinh57/codex-orchestrated-project-template --skill docs-hdtinh57

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation updates after feature changes are often out of sync with actual behavior; this skill guides creators to verify and align docs with the implementation.

Core Features & Use Cases

Verification of implementation against documentation
Diátaxis-based content classification (Tutorials, How-to guides, References, Explanations)
Living documentation discipline: pruning, rewriting, and removing outdated content to reflect the current state
Use Case: When a feature changes, update USER_GUIDE.md sections to reflect new behavior and user-facing flows

Quick Start

Run the docs update workflow to verify implementation, classify content, and refresh USER_GUIDE.md sections.

Frequently Asked Questions about docs

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

FAQPage Schema

How do I keep user-facing documentation aligned with actual feature behavior after updates?▼

To keep user-facing documentation aligned with feature behavior, verify current implementation against existing docs, rewrite outdated sections, and prune obsolete content from USER_GUIDE.md and README.md. Living-docs discipline ensures documentation reflects actual user flows and API references accurately.

What is the Diátaxis framework for documentation classification?▼

The Diátaxis framework classifies documentation into four types: tutorials, how-to guides, references, and explanations. Applying Diátaxis-based content classification helps structure onboarding guides and API references by user intent, ensuring documentation serves learning, guidance, technical description, and analysis needs.

How do I remove outdated content from README.md and USER_GUIDE.md effectively?▼

To remove outdated content from README.md and USER_GUIDE.md effectively, apply content pruning and revision workflows. Verify implementation against current behavior, classify content using Diátaxis, then rewrite or delete obsolete sections to maintain living documentation that reflects actual features.

Does this documentation update workflow require any specific dependencies or components?▼

This documentation update workflow requires no external dependencies or components. It operates as a standalone revision workflow to verify implementation, apply Diátaxis content classification, and refresh user-facing documentation without additional environment setup or package installations.

What is the best way to maintain living documentation for onboarding guides and API references?▼

The best way to maintain living documentation for onboarding guides and API references is applying continuous revision workflows. Verify implementation changes, classify content updates using the Diátaxis framework, and prune obsolete sections to ensure all user-facing documentation stays synchronized with actual feature behavior.

When should I use a living-docs discipline approach for documentation updates?▼

Use living-docs discipline when feature changes leave documentation out of sync with actual behavior. This approach is essential whenever implementation updates require corresponding verification and revision of user guides, API references, and onboarding materials to prevent documentation drift and maintain accuracy.