Agent skill
book-structure-generator
Generates comprehensive book structures for Docusaurus with proper hierarchy, navigation, and SEO. Creates chapter outlines, sidebar configurations, and ensures consistent structure across the book.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/book-structure-generator
SKILL.md
Book Structure Generator Skill
Purpose
Rapidly scaffold well-organized book structures for Docusaurus projects with:
- Logical chapter organization (Parts/Modules → Chapters → Sections)
- Proper Docusaurus sidebar configuration (TypeScript support)
- SEO-optimized frontmatter
- Consistent naming conventions
- Progressive learning path
When to Use This Skill
Use this skill when:
- Starting a new book project
- Restructuring existing documentation
- Creating comprehensive educational content
- Planning chapter dependencies and learning progression
Core Capabilities
1. Chapter Hierarchy Design
Standard Book Structure (Module-Based):
Part 0: Front Matter
├── Preface/Welcome
└── Table of Contents (auto-generated)
Module 1: Foundation (Chapters 1-3)
├── Chapter 1: Introduction
├── Chapter 2: Core Concepts
└── Chapter 3: Ecosystem
Module 2: Core Knowledge (Chapters 4-7)
├── Chapter 4: [Core Skill 1]
├── Chapter 5: [Core Skill 2]
├── Chapter 6: [Core Skill 3]
└── Chapter 7: Integration & Best Practices
Module 3: Advanced Topics (Chapters 8-10)
├── Chapter 8: Advanced Techniques
├── Chapter 9: Real-World Projects
└── Chapter 10: Future Directions
Part 4: Back Matter
├── Appendix A: Glossary
└── Appendix B: Resources
2. Sidebar Configuration Generator
Template for sidebars.ts (TypeScript):
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
const sidebars: SidebarsConfig = {
bookSidebar: [
// Welcome
{
type: 'doc',
id: 'intro', // or 'index'
label: '👋 Welcome',
},
// Module 1: Foundation
{
type: 'category',
label: '📚 Module 1: Foundation',
collapsible: true,
collapsed: false,
items: [
'modules/module-1-overview', // Overview page
'modules/module-1-planning', // Content pages...
// Add specific items or use autogenerated
],
},
// Module 2: Core Knowledge
{
type: 'category',
label: '🎯 Module 2: Core Knowledge',
collapsible: true,
collapsed: false,
items: [
{
type: 'autogenerated',
dirName: 'modules/module-2', // Auto-generate from folder
},
],
},
// Appendices
{
type: 'category',
label: '📖 Appendices',
collapsible: true,
collapsed: true,
items: [
'appendices/glossary',
'appendices/resources',
],
},
],
};
export default sidebars;
3. Chapter Outline Generation
For each chapter, generate detailed outline:
Input: Topic + Target audience + Learning goals Output: Detailed chapter structure with sections
Example Process:
Topic: "Introduction to RAG Systems"
Audience: Intermediate developers
Goals: Understand RAG architecture, implement basic RAG
Generated Outline:
├── What You'll Learn (3-5 bullets)
├── Why RAG Matters (motivation)
├── RAG Architecture Overview
│ ├── Components breakdown
│ ├── Data flow diagram
│ └── Key concepts
├── Building Your First RAG System
│ ├── Step 1: Document ingestion
│ ├── Step 2: Vector storage
│ ├── Step 3: Retrieval
│ └── Step 4: Generation
├── Best Practices
├── Common Pitfalls
└── Summary & Next Steps
4. Frontmatter Template Generation
Template: (see templates/frontmatter-template.yaml)
---
title: "Chapter [X]: [Title] - [Book Name]"
description: "[SEO-optimized 150-160 character description that captures the chapter's value and includes primary keyword]"
keywords:
- [primary-keyword]
- [secondary-keyword-1]
- [long-tail-keyword-1]
sidebar_label: "[Short Title for Sidebar]"
sidebar_position: [X]
slug: /modules/module-[X]/[slug]
tags:
- [category-tag]
- [difficulty-tag]
image: /img/modules/module-[X]-cover.png
last_update:
date: [YYYY-MM-DD]
author: [Author Name]
---
Usage Instructions
Basic Usage
Use the book-structure-generator skill to create a complete book structure for:
Topic: [Book Topic]
Target Audience: [Description]
Estimated Chapters: [Number]
Focus Areas: [List key topics]
Generate:
1. Complete chapter hierarchy (with titles)
2. Sidebar configuration (sidebars.ts)
3. Individual chapter outlines
4. File/folder structure
Advanced Usage with Customization
Use book-structure-generator skill with these customizations:
Structure Type: Tutorial-heavy (more hands-on chapters)
Chapter Count: 12 chapters
Special Requirements:
- Each chapter must have a "Try It Yourself" section
- Include 2 appendices (glossary + CLI reference)
- Add a "Quick Start" chapter before Part 1
File Naming Conventions
Chapters (Module-Based):
docs/
├── intro.md # Welcome page
├── modules/
│ ├── module-1-overview.md # Module overview
│ ├── module-1-planning.md # Chapter content
│ ├── module-2/ # Nested folder for larger modules
│ │ ├── 01-intro.md
│ │ └── 02-setup.md
│ └── ...
└── appendices/
├── glossary.md
└── resources.md
Rules:
- Use kebab-case (lowercase with hyphens)
- Start with module/chapter number for clarity
- Keep slugs concise (3-4 words max)
- Be descriptive (avoid generic names like "chapter-4.md")
Quality Checklist
Every generated structure must ensure:
- Logical progression (simple → complex)
- Clear learning path (each chapter builds on previous)
- Balanced chapter lengths (2000-4000 words each)
- Consistent naming conventions
- SEO-optimized titles and descriptions
- Proper sidebar hierarchy (matching
sidebars.ts) - Mobile-friendly navigation
- Cross-references planned
Examples
See examples/sample-chapter.md for a complete chapter example following this structure.
Integration with Subagents
Use with:
- content-writer subagent: After generating structure, use content-writer to fill chapters
- docusaurus-architect subagent: For implementing the sidebar configuration
Customization Options
The skill supports these variations:
Structure Types:
academic: Heavy on theory, formal tonetutorial: Hands-on, project-basedreference: Comprehensive API/command documentationhybrid: Mix of conceptual and practical (default)
Chapter Lengths:
short: 1500-2500 words (quick reads)medium: 2000-4000 words (standard)long: 4000-6000 words (deep dives)
Learning Styles:
beginner: More explanation, simpler examplesintermediate: Balanced theory and practiceadvanced: Assumes knowledge, focuses on nuance
Output Format
When this skill is invoked, provide:
- Complete Chapter List (with tentative titles)
- Sidebar Configuration (ready-to-use
sidebars.ts) - File Structure (directory tree)
- Chapter Outlines (detailed structure for each chapter)
- Frontmatter Templates (for each chapter)
- Cross-Reference Map (which chapters reference each other)
Time Savings
Without this skill: 3-4 hours to manually plan structure With this skill: 10-15 minutes to generate complete structure
Efficiency gain: ~90% time reduction
Didn't find tool you were looking for?