doc-index-required

Community

Ensure docs are indexed and non-duplicative

Authorexception-coder
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Ensures documentation consistency by enforcing a pre-write index check and a post-write index update for any files under docs/, preventing duplicate documents, unclear content boundaries, and stale indexes across the project.

Core Features & Use Cases

  • Phase-A (pre-write): Read docs/INDEX.md and the target subdirectory INDEX.md, scan existing markdown files, infer titles, detect content overlap, and recommend merging or boundary adjustments before allowing new writes.
  • Phase-B (post-write): After a document is created or modified, generate suggested INDEX.md updates (new entries, updated summaries or outlines) and surface them for user confirmation before committing changes.
  • Use Case: Before creating a new design document, the skill detects similarly scoped docs in docs/design/, warns about overlap, and suggests appending to an existing document or adding a new indexed entry.

Quick Start

Use the doc-index-required skill to run Phase-A before editing any docs/ file and run Phase-B after saving to propose index updates.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: doc-index-required
Download link: https://github.com/exception-coder/team-standards/archive/main.zip#doc-index-required

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.