doc-index-required

Enforce pre-write analysis and post-write index updates for Markdown files under docs/.

6|1|Updated Mar 30, 2026
One-click install
npx skills add https://github.com/exception-coder/team-standards --skill doc-index-required
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-index-required
Source: https://github.com/exception-coder/team-standards/tree/main/skills/doc-index-required
Command: npx skills add https://github.com/exception-coder/team-standards --skill doc-index-required

SYSTEM DOCUMENTATION & REQUIREMENTS

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.

Frequently Asked Questions about doc-index-required

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

FAQPage Schema
How do I prevent duplicate documentation when adding new markdown files to docs/?

To prevent duplicate documentation, a pre-write analysis scans existing markdown files in docs/, infers their titles, detects content overlap, and recommends merging or boundary adjustments before you create new files.

How do I keep my docs/INDEX.md updated automatically after editing markdown files?

To keep docs/INDEX.md updated, run a post-write index update after saving markdown changes to generate suggested INDEX.md entries, updated summaries, and outlines for user confirmation before committing.

What is boundary analysis for documentation and how does it manage content overlap?

Boundary analysis for documentation scans existing markdown files in target subdirectories, infers their titles, detects content overlap, and suggests merging or adjusting boundaries before allowing new document writes.

Can I apply documentation indexing workflows when moving or reorganizing existing markdown files?

Yes, you can apply documentation indexing workflows to any action that creates, edits, moves, or reorganizes markdown files in docs/, ensuring pre-write overlap checks and post-write index updates are enforced.

Do I need per-subdir INDEX.md files to use the doc indexing workflow?

Yes, the doc indexing workflow reads and updates both the root docs/INDEX.md and per-subdir INDEX.md files to detect title and outline changes, identify overlaps, and produce accurate index update suggestions.

Why does my documentation index show stale entries after reorganizing markdown files?

Your documentation index shows stale entries because a post-write index update was not run after reorganizing markdown files, meaning new summaries and outlines were never generated for confirmation.