bmad-index-docs

Generate or update an index.md file with content-based summaries for documentation folders.

Updated Apr 23, 2026
One-click install
npx skills add https://github.com/ncptuan/stock_backtest_project --skill bmad-index-docs-ncptuan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bmad-index-docs
Source: https://github.com/ncptuan/stock_backtest_project/tree/main/.claude/skills/bmad-index-docs
Command: npx skills add https://github.com/ncptuan/stock_backtest_project --skill bmad-index-docs-ncptuan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you quickly create or refresh an index.md file for a documentation folder, so people can understand what files exist and navigate them without manually reviewing every document.

Core Features & Use Cases

  • Directory Scanning: Reviews files and subdirectories in a target folder before building the index.
  • Content-Based Summaries: Reads each file to generate short descriptions based on actual content instead of guessing from filenames.
  • Organized Navigation: Groups files by location and keeps entries sorted for a clean, maintainable directory index.
  • Use Case: Ideal when a docs folder has grown over time and needs a reliable index page for onboarding, project handoff, or knowledge management.

Quick Start

Use the bmad-index-docs skill to generate or update index.md for the docs folder and summarize each file based on its contents.

Frequently Asked Questions about bmad-index-docs

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

FAQPage Schema
How do I generate an index.md file for a documentation directory?

To generate an index.md file for a documentation directory, the Skill scans the target folder, reads file contents to create concise descriptions, formats relative paths, sorts entries alphabetically, and writes the organized index.md file.

Can I automatically create file summaries for my docs folder based on actual content?

Yes, you can create file summaries based on actual content because the Skill reads each documentation file to generate short descriptions instead of guessing from filenames, ensuring accurate and content-based knowledge management.

Does the directory scanning exclude hidden files when building a markdown index?

Yes, directory scanning excludes hidden files when building the markdown index. The Skill applies hidden file exclusion and alphabetical sorting to maintain a clean and organized directory listing for navigation.

What is the best way to maintain an organized index page for project onboarding?

The best way to maintain an organized index page for project onboarding is to generate or update an index.md file that groups files by location, providing a reliable directory index for navigation and knowledge management.

Do I need write access to update a folder index for documentation files?

Yes, you need write access to update a folder index for documentation files. The Skill requires write access validation to successfully generate or refresh the index.md file in the target documentation directory.