book-writing-workspace

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Book Writing Workspace

书籍写作工作区

Set up a professional book writing workspace with AI-assisted workflow support.
搭建一个支持AI辅助工作流的专业书籍写作工作区。

When to use

适用场景

  • Book writing, technical writing, 執筆プロジェクト
  • Creating a new book or technical writing project
  • Setting up Markdown → Re:VIEW → PDF workflow
  • 书籍写作技术写作執筆プロジェクト
  • 创建新书或技术写作项目
  • 搭建Markdown → Re:VIEW → PDF工作流

Quick Start

快速开始

powershell
python scripts/setup_workspace.py `
    --name "project-name" `
    --title "Book Title" `
    --path "D:\target\path" `
    --chapters 8
powershell
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. Customize: Edit
    docs/page-allocation.md
    and
    .github/copilot-instructions.md
  1. 收集信息:项目名称、书籍标题、存储路径、章节数量
  2. 运行脚本
    scripts/setup_workspace.py
  3. 自定义配置:编辑
    docs/page-allocation.md
    .github/copilot-instructions.md

Agents Overview

Agents概览

AgentRolePermissions
@writing
Write and edit manuscriptsEdit
02_contents/
@writing-reviewer
Review manuscripts (P1/P2/P3)Read only
@converter
Convert Markdown to Re:VIEWEdit
03_re-view_output/
@orchestrator
Coordinate workflowDelegate to agents
Agent角色职责权限
@writing
撰写和编辑手稿编辑
02_contents/
目录
@writing-reviewer
审核手稿(P1/P2/P3)仅读取权限
@converter
将Markdown转换为Re:VIEW格式编辑
03_re-view_output/
目录
@orchestrator
协调工作流执行委派任务给其他agents

Dependencies

依赖工具

ToolPurposeRequired
Python 3.8+ScriptsYes
GitVersion controlYes
DockerRe:VIEW PDF buildOptional
工具用途是否必需
Python 3.8+运行脚本
Git版本控制
DockerRe:VIEW PDF构建可选

Done Criteria

完成标准

  • Workspace folder structure created
  • 4 agents deployed to
    .github/agents/
  • docs/page-allocation.md
    configured
  • /gc_Commit
    prompt working
  • 已创建工作区文件夹结构
  • 已将4个agents部署到
    .github/agents/
    目录
  • 已配置
    docs/page-allocation.md
    文件
  • /gc_Commit
    提示词可正常使用

Key References

关键参考

TopicReference
Folder Structurereferences/folder-structure.md
Agentsreferences/AGENTS.md
Instructionsreferences/copilot-instructions.md
主题参考链接
文件夹结构references/folder-structure.md
Agents说明references/AGENTS.md
操作指南references/copilot-instructions.md