evidence-indexing

Generates INDEX.md and README.md for evidence directories and checks artifact existence.

2|Updated Jul 13, 2025

Search Tags:#software engineering #validation #directory structure #evidence indexing #artifact enumeration

Ready to run

npx skills add https://github.com/krzemienski/shannon --skill evidence-indexing

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: evidence-indexing
Source: https://github.com/krzemienski/shannon/tree/main/skills/evidence-indexing
Command: npx skills add https://github.com/krzemienski/shannon --skill evidence-indexing

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill guarantees that every evidence directory is fully indexed, ensuring all artifacts are accounted for and accessible during reviews.

Core Features & Use Cases

Automatic Indexing: Generates and maintains README.md and INDEX.md for evidence directories, listing all artifacts with details.
Artifact Verification: Checks the existence of artifacts on disk against the INDEX.md list.
Directory Validation: Ensures every directory under e2e-evidence/<run-id>/ has an index, aiding in mechanical traversal by completion-gate.

Quick Start

Use the evidence-indexing skill to index evidence for the current phase.

Frequently Asked Questions about evidence-indexing

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

FAQPage Schema

How do I index artifacts in an evidence directory for automated review?▼

Evidence directory indexing generates INDEX.md and README.md files to enumerate all artifacts with details, ensuring every directory under e2e-evidence/<run-id>/ is fully accounted for and accessible during reviews and gate traversal.

How do I verify artifact existence on disk against an index file?▼

Verifying artifact existence checks the actual files on disk against the documented INDEX.md list to ensure every artifact recorded in the evidence directory physically exists and is ready for post-phase review.

What is the best way to ensure directory validation for completion gate readiness?▼

Ensuring directory validation for completion gate readiness requires indexing every directory under e2e-evidence/<run-id>/ to aid mechanical traversal by the completion-gate, verifying all phase artifacts are present and properly enumerated.

When do I need to generate README.md and INDEX.md files for post-phase artifact enumeration?▼

Generating README.md and INDEX.md files for post-phase artifact enumeration is required after completing a project phase to guarantee all evidence artifacts are listed, verified against disk, and prepared for gate traversal.

Why does my completion gate fail to traverse evidence directories?▼

Completion gate traversal fails to traverse evidence directories when they lack properly generated INDEX.md and README.md files, preventing mechanical verification of artifact existence and directory validation for the current phase.