Book Writing Workspace

Create a reusable manuscript workspace with folders, agents, prompts, instructions, and setup scripts.

When to use

• Book writing, technical writing, 執筆プロジェクト, Re:VIEW
• Creating a new book or technical writing project
• Bootstrapping a manuscript repository from templates
• Setting up Markdown → Re:VIEW → PDF workflow

Quick Start

python scripts/setup_workspace.py `
    --name "project-name" `
    --title "Book Title" `
    --path "D:\target\path" `
    --chapters 8

Setup Workflow

1. Gather info: Project name, title, location, chapter count
2. Run script: scripts/setup_workspace.py
3. Review output: Confirm README, agents, prompts, and docs were created
4. Customize: Edit docs/page-allocation.md, docs/schedule.md, and .github/copilot-instructions.md

Generated Workspace

• Manuscript folders under 01_contents_keyPoints/, 02_contents/, and 04_images/
• AI workflow files under .github/agents/, .github/instructions/, and .github/prompts/
• Project docs such as README.md, docs/page-allocation.md, and docs/schedule.md
• Helper scripts such as scripts/count_chars.py and scripts/convert_md_to_review.py

Recommended Writing Unit

• Use 1 file = 1 section as the default manuscript unit.
• Keep chapter intro in ch{N}-00_<title>.md and section files in ch{N}-01_..., ch{N}-02_....
• For PDF/Re:VIEW output, heading levels define hierarchy, while file split mainly improves authoring and review workflow.

Migration Checklist (Path / Naming Changes)

When reorganizing workspace paths or file naming rules, update these together:

1. Docs: docs/naming-conventions.md, docs/page-allocation.md, docs/writing-guide.md
2. Instructions: templates/instructions/writing-*.instructions.md (applyTo and examples)
3. Scripts: templates/scripts/count_chars.py, templates/scripts/convert_md_to_review.py
4. Agent docs: templates/agents/*.agent.md if paths are explicitly written

Then verify with:

• python scripts/count_chars.py
• python scripts/convert_md_to_review.py

Agents Overview

Agent	Role	Permissions
@writing	Write and edit manuscripts	Edit 02_contents/
@writing-reviewer	Review manuscripts (P1/P2/P3)	Read only
@converter	Convert Markdown to Re:VIEW	Edit 03_re-view_output/
@orchestrator	Coordinate workflow	Delegate to agents

Dependencies

Tool	Purpose	Required
Python 3.8+	Scripts	Yes
Git	Version control	Yes
Docker	Re:VIEW PDF build	Optional

Done Criteria

• Workspace folder structure created
• 4 agents deployed to .github/agents/
• docs/page-allocation.md configured
• README.md and docs/schedule.md customized
• /gc_Commit prompt working

Key References

Topic	Reference
Folder Structure	references/folder-structure.md
Setup Workflow	references/setup-workflow.md
Customization	references/customization-points.md
Re:VIEW PDF Tips	references/review-pdf-tips.md