Back to Skills

project-indexing

verified

Generates SHANNON_INDEX for 94% token reduction (58K → 3K tokens). Compresses large codebases into structured summaries with Quick Stats, Tech Stack, Core Modules, Dependencies, Recent Changes, and Key Patterns. Enables fast agent onboarding, efficient multi-agent coordination, and instant context switching. Use when: starting project analysis, onboarding new agents, coordinating waves, switching between codebases, or when context window efficiency is critical.

View on GitHub

Marketplace

shannon-framework

krzemienski/shannon-framework

Plugin

shannon

Repository

krzemienski/shannon-framework
1stars

skills/project-indexing/SKILL.md

Last Verified

January 21, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/krzemienski/shannon-framework/blob/main/skills/project-indexing/SKILL.md -a claude-code --skill project-indexing

Installation paths:

Claude
.claude/skills/project-indexing/
Powered by add-skill CLI

Instructions

# Project Indexing

## Overview

**Purpose**: Shannon's codebase compression system that achieves 94% token reduction (58K → 3K tokens) by generating structured SHANNON_INDEX files. Transforms linear file-by-file exploration into instant structured lookups, enabling fast agent onboarding, efficient multi-agent coordination, and sustainable context window usage.

**ROI Proven**: 40,000+ tokens saved per project analysis, 12-60x speedup, eliminates redundant file reads in multi-agent scenarios.

## When to Use

Use this skill when:
- Starting ANY project analysis or implementation (always generate index first)
- Onboarding new agents to existing codebase
- Launching multi-agent wave execution
- Switching between multiple projects/codebases
- Context window efficiency is critical
- After major codebase changes (regenerate index)

DO NOT use when:
- **NEVER skip** - Even "small" or "focused" questions benefit from indexing (see Anti-Rationalization section)
- Index already generated and current (< 24 hours old, no major changes)

## Core Competencies

1. **94% Token Compression**: Reduces 58K full codebase to 3K structured summary through hierarchical summarization and pattern abstraction
2. **Project Scan**: Discovers file counts, languages, LOC, dependencies without loading full content (500 token cost)
3. **Architecture Summarization**: Identifies core modules, key patterns, tech stack from directory structure and metadata (1,500 token cost)
4. **Context Enrichment**: Adds git recent changes, dependency analysis, testing setup (500 token cost)
5. **Template Population**: Generates structured SHANNON_INDEX.md following 7-section template (500 token cost)
6. **Serena Persistence**: Stores index in memory for cross-session retrieval and wave agent coordination (100 token cost)
7. **Multi-Agent Optimization**: Enables 81-95% token savings in parallel wave execution scenarios

## Inputs

**Required:**
- `project_path` (string): Absolute path to project root directory

**O

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
32885 chars