audit

Generate a structured markdown audit document for metrics or pipeline steps.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/vitalwarley/hyprdots --skill audit-vitalwarley
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit
Source: https://github.com/vitalwarley/hyprdots/tree/main/claude-global/skills/audit
Command: npx skills add https://github.com/vitalwarley/hyprdots --skill audit-vitalwarley

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps researchers and engineers verify that metric implementations and pipeline steps are correct, reproducible, and appropriately documented so that reported values in analyses and papers can be trusted.

Core Features & Use Cases

  • Locate implementation: Find the function or script that computes the named metric or pipeline step and enumerate inputs, outputs, and assumptions.
  • Verify embeddings and checkpoints: Check embedding provenance and ensure computations use validated checkpoints and expected sample counts.
  • Recompute and compare: Run reproducible scripts to recompute metric values, capture diagnostics, and compare them to reported numbers.
  • Produce formal audit report: Generate a structured markdown audit with pre-conditions, process checks, post-conditions, findings, limitations, and a safe claim statement.
  • Governance actions: Create issues for investigation, update global audit trackers, and reference commits and evidence for traceability.

Quick Start

Audit the metric gaussian entropy by locating its implementation, recomputing results against the canonical embeddings, and writing a reproducible audit document to report/sprints/week-NN/gaussian-entropy-audit.md.

Frequently Asked Questions about audit

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

FAQPage Schema
How do I audit a metric implementation for reproducibility in a research codebase?

Pipeline auditing involves reading code and reports, verifying embedding provenance and checkpoint validity, recomputing metrics with reproducible scripts, and producing a linked markdown document with evidence, findings, limitations, and a safe claim statement.

When do I need to revalidate embedding-based analyses after a checkpoint change?

A reproducible audit report for a pipeline step includes pre-conditions, process verification checks, post-conditions, findings, limitations, a safe claim statement, and references to commits and evidence for full traceability.

How do I verify embedding provenance and sample counts before recomputing metrics?

After completing a pipeline audit, you create issues for investigation, update global audit trackers, and reference commits and evidence for traceability to maintain governance over the codebase validation process.

What is the best way to generate a structured audit document for a metric function?

Locating a metric implementation requires reading the research codebase to find the function or script computing the named metric, then enumerating its inputs, outputs, and assumptions to verify correctness before recomputing values.

Can I use this approach to audit extraction pipelines and embedding-based analyses?

Code review and revalidation auditing differ from standard code review by requiring reproducible scripts to recompute metric values against specified embedding files, capturing diagnostics, and comparing them to reported numbers in a formal markdown document.

Why does my reported metric value not match the recomputed result after an audit?

Limitations of revalidation auditing include dependency on reading existing code and reports, requiring specified embedding files and validated checkpoints, and the need for reproducible scripts to ensure accurate recomputation and comparison of metric values.