ARS.FLOW
← Back to skills
Repo Workflow BootstrapMedium ReliabilityLow-Risk Workflow

README Doc Drift Detector

Checks README command references against executable script definitions to prevent onboarding and operation drift.

Version

0.1.0

Last Updated

Apr 22, 2026

Verification Type

static analysis, manual review required

Downloads

0

Required inputs

  • readme (markdown)

    README command and setup instructions.

  • scripts_manifest (json)

    Executable script definition source (e.g., package.json scripts).

Expected outputs

  • doc_drift_report (markdown)

    Drift findings and remediation actions.

Included checks and assets

  • scripts/check_readme_scripts.py (script)

    Compares documented npm commands against package.json scripts.

  • references/readme-command-format.md (reference)

    Standard README command formatting guidance.

  • references/drift-severity-policy.md (reference)

    Severity policy for documentation drift findings.

Failure modes

  • Command extraction can miss non-standard formatting.
  • Aliases may appear as false drift without normalization.
  • Non-npm toolchains need additional adapters.

Ideal use cases

  • Onboarding doc quality checks
  • Release readiness documentation audits
  • CI documentation consistency gates

Example runs

README script drift check

Validated sample run

Detects stale command references after script renaming.

Input preview

README.md + package.json

Output preview

1 stale command and 1 undocumented executable

Changelog summary

  • 0.1.0 · Apr 22, 2026

    Initial release for README command drift detection.

Links

Inspect the source, read authored documentation, or download the published skill bundle.

DownloadSourceDocs