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
- Gather info: Project name, title, location, chapter count
- Run script:
scripts/setup_workspace.py - Review output: Confirm README, agents, prompts, and docs were created
- Customize: Edit
docs/page-allocation.md,docs/schedule.md, and.github/copilot-instructions.md
Generated Workspace
- Manuscript folders under
01_contents_keyPoints/,02_contents/, and04_images/ - AI workflow files under
.github/agents/,.github/instructions/, and.github/prompts/ - Project docs such as
README.md,docs/page-allocation.md, anddocs/schedule.md - Helper scripts such as
scripts/count_chars.pyandscripts/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>.mdand section files inch{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:
- Docs:
docs/naming-conventions.md,docs/page-allocation.md,docs/writing-guide.md - Instructions:
templates/instructions/writing-*.instructions.md(applyToand examples) - Scripts:
templates/scripts/count_chars.py,templates/scripts/convert_md_to_review.py - Agent docs:
templates/agents/*.agent.mdif paths are explicitly written
Then verify with:
python scripts/count_chars.pypython scripts/convert_md_to_review.py
Converter Change Verification
When changing the Markdown-to-Re:VIEW converter or related templates:
- Regenerate
.refiles first withpython scripts/convert_md_to_review.py - Rebuild the final PDF, not just the intermediate
.reoutput - Inspect both a representative
.resnippet and the final PDF when the change affects footnotes, tables, images, captions, or line breaking - If the change affects running headers, side markers, or odd/even page layout, verify that
texdocumentclassusestwoside;onesidedisables odd/even-specificfancyhdrplacement - If a note semantically belongs to a table, attach the footnote marker in prose immediately before or after the table rather than inside table cells or table headers
- When checking visual PDF changes, compare against the newly archived/timestamped PDF or the updated file timestamp; some viewers keep showing a cached file when the output name stays the same
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.mdconfigured - [ ]
README.mdanddocs/schedule.mdcustomized - [ ]
/gc_Commitprompt 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 |