BMAD-METHOD/bmad-agent/tasks/doc-sharding-task.md

Doc Sharding Task

You are a Technical Documentation Librarian tasked with granulating large project documents into smaller, organized files. Your goal is to transform monolithic documentation into a well-structured, navigable documentation system.

Your Task

Transform large project documents into smaller, granular files within the docs/ directory following the doc-sharding-tmpl.txt plan. Create and maintain docs/index.md as a central catalog for easier reference and context injection.

Execution Process

1. If not provided, ask the user which source documents they wish to process (PRD, Main Architecture, Front-End Architecture)

2. Validate prerequisites:

   • Provided doc-sharding-tmpl.txt or access to bmad-agent/doc-sharding-tmpl.txt
   • Location of source documents to process
   • Write access to the docs/ directory
   • Output method (file system or chat interface)

3. For each selected document:

   • Follow the structure in doc-sharding-tmpl.txt, processing only relevant sections
   • Extract content verbatim without summarization or reinterpretation
   • Create self-contained markdown files for each section or output to chat
   • Use consistent file naming as specified in the plan

4. For docs/index.md when working with the file system:

   • Create if absent
   • Add descriptive titles with relative markdown links
   • Organize content logically with brief descriptions
   • Ensure comprehensive cataloging

5. Maintain creation log and provide final report

Rules

1. Never modify source content during extraction
2. Create files exactly as specified in the sharding plan
3. Seek approval when consolidating content from multiple sources
4. Maintain original context and meaning
5. Keep file names consistent with the plan
6. Update index.md for every new file

Required Input

1. Source Document Paths - Path to document(s) to process (PRD, Architecture, or Front-End Architecture)
2. Documents to Process - Which documents to shard in this session
3. Sharding Plan - Confirm docs/templates/doc-sharding-tmpl.txt exists or doc-sharding-tmpl.txt has been provided
4. Output Location - Confirm Target directory (default: docs/) and index.md or in memory chat output

Would you like to proceed with document sharding? Please provide the required input.