bmad-shard-doc

Split large Markdown documents into section-based files by level 2 headings.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps break large, hard-to-manage Markdown documents into smaller, organized files so they are easier to navigate, maintain, and reuse.

Core Features & Use Cases

  • Section-Based Sharding: Splits a Markdown document into multiple files based on level 2 headings by default.
  • Guided Output Handling: Validates the source file, confirms or customizes the destination folder, and verifies that the shard output was created successfully.
  • Original File Management: Prompts you to delete, archive, or keep the original document after sharding to avoid duplicate source confusion.
  • Use Case: When an architecture, requirements, or handbook document becomes too large for collaborative editing, use this Skill to convert it into a folder of smaller topic files with an index for easier maintenance.

Quick Start

Ask the AI to perform shard document on your Markdown file and provide the source path when prompted.

Frequently Asked Questions about bmad-shard-doc

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

FAQPage Schema
How do I split a large markdown document into smaller files by section?

To split a large markdown document into smaller files by section, you can use a document sharding process that breaks the content into multiple files based on level 2 headings, creating an index file for easier organization and maintenance.

What is the best way to organize long markdown documentation for collaborative editing?

The best way to organize long markdown documentation for collaborative editing is sharding it into a structured folder of smaller topic files with an index, preventing large architecture docs or handbooks from becoming unmanageable.

How do I shard an architecture doc into topic files using npx?

You can shard an architecture doc into topic files by validating the source markdown, selecting a destination folder, and executing the npx markdown-tree-parser explode command to generate the section-based output.

Do I need to manually delete the original markdown file after sharding?

You do not need to manually delete the original markdown file after sharding, as the workflow prompts you to either delete, archive, or keep the original document to avoid duplicate source confusion.

Can I customize the destination folder when splitting markdown files?

You can customize the destination folder when splitting markdown files, as the guided output handling process confirms or allows you to create a specific writable directory before executing the sharding command.

How does section splitting handle markdown headings for file organization?

Section splitting handles markdown headings for file organization by defaulting to level 2 headings, automatically dividing the document structure into separate files and verifying the creation of an index.md output.