docs

Update user-facing docs to match actual code and feature behavior.

94|49|Updated Mar 25, 2026
One-click install
npx skills add https://github.com/josipjelic/orchestrated-project-template --skill docs-josipjelic
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/josipjelic/orchestrated-project-template/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/josipjelic/orchestrated-project-template --skill docs-josipjelic

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts away from the actual code and features, creating confusing onboarding and outdated API references. This Skill provides a repeatable process to verify and update user-facing docs so they reflect the current implementation and release state.

Core Features & Use Cases

  • Read and verify actual implementations using code exploration to ensure documentation matches what exists.
  • Classify content using the Diátaxis framework (Tutorial, How-to, Reference, Explanation) to guide writing style.
  • Update onboarding flows and USER_GUIDE.md sections to keep user journeys aligned with the product.
  • Enforce concise, imperative language and accuracy to prevent documentation drift.

Quick Start

Run the documentation update protocol after a feature change to ensure all guides reflect the current implementation.

Frequently Asked Questions about docs

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

FAQPage Schema
How do I keep API documentation and user guides accurate after feature updates?

To keep API documentation accurate after feature updates, you need a repeatable process that verifies actual code implementations and updates user-facing docs to reflect current release states, preventing documentation drift.

What is the Diátaxis framework and how does it apply to writing technical documentation?

The Diátaxis framework classifies technical documentation into four types: Tutorials, How-to guides, Reference, and Explanation. Applying it guides the writing style and structure to ensure content matches user intent and clarity standards.

How do I fix outdated onboarding flows that no longer match my product's current behavior?

Fix outdated onboarding flows by exploring the actual codebase to verify current feature behavior, then updating onboarding sections and USER_GUIDE.md files to align user journeys with the real product implementation.

What is the best way to prevent documentation drift across user-facing guides?

The best way to prevent documentation drift is enforcing a documentation update protocol after every feature change, ensuring guides are verified against actual code and written with concise, imperative language.

Can I use this approach to update documentation for both new features and API changes?

Yes, this approach supports updating documentation for feature releases, onboarding updates, API changes, and existing documentation gaps by verifying actual implementations and applying Diátaxis classification to guide the writing workflow.

When should I run a documentation update protocol during the development workflow?

Run the documentation update protocol immediately after a feature change or release to ensure all user-facing guides and API references reflect the current implementation state, maintaining accuracy and preventing onboarding confusion.