doc-drift

Detect and score documentation drift between the docs wiki and live application.

17|1|Updated Nov 17, 2024
One-click install
npx skills add https://github.com/mifunedev/orchestra --skill doc-drift-mifunedev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-drift
Source: https://github.com/mifunedev/orchestra/tree/main/.claude/skills/doc-drift
Command: npx skills add https://github.com/mifunedev/orchestra --skill doc-drift-mifunedev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Detect and score documentation drift between docs.ruska.ai (Docusaurus wiki) and chat.ruska.ai (React+FastAPI app). Provides domain knowledge for drift categories, scoring rubric, crawl strategies, council assessment criteria, and output format templates. Used by the /doc-drift command which orchestrates an Agent Team of crawlers and assessors.

Core Features & Use Cases

  • Drift Categories: definitions and taxonomy for common documentation gaps.
  • Scoring Rubric: a composite scoring model to quantify drift across documents and behaviors.
  • Crawl Strategies: structured approaches to crawl docs.ruska.ai and chat.ruska.ai to collect evidence.
  • Council Assessment: criteria to evaluate findings and produce standardized drift reports.
  • Output Templates: templates for drift manifests, evidence capture, and recommendations.

Quick Start

Run the /doc-drift command to orchestrate a drift audit across docs and app.

Frequently Asked Questions about doc-drift

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

FAQPage Schema
How do I detect documentation drift between a wiki and a live application?

Documentation drift between a wiki and a live application is detected by crawling both systems to collect evidence, comparing the content, and scoring the alignment gaps. This Skill provides taxonomy, crawl strategies, and scoring rubrics to automate the assessment.

What is the best way to audit consistency between a Docusaurus wiki and a React app?

Auditing consistency between a Docusaurus wiki and a React app is best handled through a structured drift assessment. The Skill orchestrates crawlers and assessors to compare cross-system behaviors, evaluate findings, and produce a standardized drift report.

How do I score and quantify documentation gaps for governance reporting?

Documentation gaps are quantified using a composite scoring rubric that measures drift across documents and behaviors. The Skill generates structured drift manifests, evidence captures, and recommendation templates suitable for governance workflows.

Can I automate cross-system consistency checks for documentation audits?

Cross-system consistency checks for documentation audits can be automated using an Agent Team of crawlers and assessors. Running the orchestration command collects evidence from both the docs and app environments to evaluate alignment.

What categories of documentation drift should I look for during an audit?

Common documentation drift categories include structured definitions and taxonomies for gaps found between the wiki and the live application. The Skill provides specific council assessment criteria to evaluate these findings and generate standardized reports.

Does this documentation drift assessment approach require specific framework dependencies?

The documentation drift assessment approach requires no external dependencies. It uses internal domain knowledge for crawl strategies and scoring rubrics to orchestrate an Agent Team that evaluates the target docs and app directly.