Book Writing Workspace
Create and maintain a reusable manuscript workspace with folders, agents, prompts, instructions, setup scripts, and a repeatable Markdown -> Re:VIEW -> PDF workflow.
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
- Upgrading an existing manuscript workspace so it can generate Re:VIEW output and printable PDFs
- Standardizing PDF house style, title pages, running headers, side markers, metadata, and review output folders across multiple books in the same repo
- Standardizing metadata layers, cover assets, series title patterns, and cover typography across multiple books in the same repo
Quick Start
python scripts/setup_workspace.py `
--name "project-name" `
--title "Book Title" `
--path "D:\target\path" `
--chapters 8Existing Workspace Upgrade
When the workspace already exists, do not stop at setup-oriented advice. This skill should also support:
- Creating or normalizing
03_re-view_output/ - Converting existing manuscript Markdown into
.re - Building PDF with Docker +
vvakame/review - Applying shared house style defaults and a metadata layer for title page, cover image, colophon, and project-specific book metadata
- Verifying both the intermediate
.reoutput and the final PDF
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,.github/copilot-instructions.md, andconfig/review-metadata/project.yml
Metadata, migration, converter verification, and sync-back rules live in references. Keep the main SKILL focused on setup and operating flow.
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.py,scripts/convert_md_to_review.py,scripts/build_review_pdf.py,scripts/inspect_pdf.py, andscripts/review_metadata.py - Re:VIEW metadata templates such as
config/review-metadata/common.ymlandconfig/review-metadata/project.yml
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.
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 |
Reference Map
| Topic | Reference |
|---|---|
| Folder structure | references/folder-structure.md |
| Setup workflow | references/setup-workflow.md |
| Customization points | references/customization-points.md |
| Re:VIEW / PDF tips | references/review-pdf-tips.md |
Done Criteria
- Workspace folder structure created
- 4 agents deployed to
.github/agents/ docs/page-allocation.mdconfiguredREADME.mdanddocs/schedule.mdcustomized/gc_Commitprompt workingconfig/review-metadata/common.ymlandproject.ymlcustomized appropriately03_re-view_output/can regenerate.refiles- PDF build works on a clean run