关于 cw-setup-project
cw-setup-project 是 Compound Writing 技能,可创建包含指南和工作目录的可移植写作空间。它会保留现有文件,支持仅补充缺失内容,也可选择加入受众指南。
主要功能
- 01创建规定的写作空间结构
- 02区分声音与风格指南
- 03可选添加受众指南
- 04保留现有文件和惯例
- 05支持迁移旧版 TASTE.md
适用场景
- 01为写作项目建立专用空间
- 02向现有文件夹补充缺失的 Compound Writing 文件
- 03将旧有规范整理到声音与风格指南中
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ everyinc/ compound-writing --skill cw-setup-project安装后在 Claude Code 中输入/cw-setup-project确认已加载。
附带文件agents/openai.yamlscripts/create_project.py
详细介绍
设置写作空间
创建一个可独立于插件使用的便携文件夹,其中包含 Compound Writing 所需的上下文和工作区。
确定目标位置
- 使用用户提供的路径或文件夹名称。
- 如果目标位置不明确,且自行选择会导致写作空间创建在实质上不同的位置,请询问路径。
- 写入前先阅读现有的工作区说明。
- 切勿在已安装的插件或运行时缓存中创建写作空间文件。
创建写作空间
创建以下精确的最小结构:
writing-home/
├── VOICE.md
├── STYLE.md
├── examples/
│ └── README.md
└── drafts/
└── README.md
通过相对于此 SKILL.md 的路径解析来运行随附的创建脚本;不要假设用户的工作目录是插件根目录:
python3 "<plugin-root>/skills/cw-setup-project/scripts/create_project.py" "/path/to/writing-home"
该脚本会从 defaults/project-template/ 复制规范模板。它可以创建新文件夹,也可以填充空文件夹。默认情况下,它拒绝修改非空文件夹,且绝不会覆盖文件。
对于已有文件夹,请先检查。如果用户明确要求添加 Compound Writing 结构,请运行:
python3 "<plugin-root>/skills/cw-setup-project/scripts/create_project.py" "/path/to/writing-home" --add-missing
--add-missing 只会创建缺失的项目。保留所有现有文件和惯例。
可选的受众指南
如果作者要求建立受众背景,且尚未指定现有维护中的共享指南,请在创建脚本命令中添加 --with-audience。对于已有的写作空间,请先检查,再与 --add-missing 一起使用。这样会添加通用的 AUDIENCE.md 模板,且不会覆盖任何现有文件。
如果已有共享受众指南适用于此工作,请在项目说明中引用该指南,而不是创建重复内容。本地的 AUDIENCE.md 是可选的;不要仅因缺少该文件就添加它或中断写作。请使用 ../../references/context-contract.md 中的受众判定规则。
明确区分各文件用途
VOICE.md回答:句子应该听起来怎样? 在此记录句法、措辞和语气,包括节奏、韵律、语域、标点和口头禅。STYLE.md回答:文章必须做什么、包含什么并证明什么? 在此记录论点、证据、文章结构、实质性标准、对受众的承诺以及是否达到可发布状态的标准。- 可选的
AUDIENCE.md回答:我们为谁写作,什么内容可能吸引他们? 在此记录读者的处境、知识、需求、兴趣、抵触因素及其证据;如果已有命名的共享指南,请使用该指南。 examples/存放经过筛选的正面和负面示例。示例是书面规则的依据,而非规则本身。drafts/为每篇作品存放一个文件夹:drafts/<piece-slug>/。将该作品的笔记、研究、提纲、草稿版本和评审集中存放在一起。
切勿将论点、证据、结构或可发布性规则写入 VOICE.md。切勿将选词、句子构造、节奏或语气规则写入 STYLE.md。将混合反馈拆分为不同规则。
设置时不要创建 TASTE.md、context.md、published/ 或 .status.yaml。
迁移旧项目
当存在 TASTE.md 时:
- 连同现有项目说明一起阅读。
- 将句法、措辞和语气规则归入
VOICE.md。 - 将论点、证据、文章结构、实质性标准和可发布性规则归入
STYLE.md。 - 如有要求,将持久有效的读者知识归入受维护的
AUDIENCE.md;使用现有共享指南,而不是创建重复内容。标明混杂或冲突的指导。 - 更改含糊不清或权威性较高的指导前,先展示迁移摘要。
- 保留
TASTE.md,直到用户明确批准删除或归档。
开始编写指南
首次运行设置完成后,开始 cw-onboarding,让作者通过简短对话、现有文稿或正在进行的工作,为两份指南补充实用的初版。不要因为尚未完成任一配置文件而阻止用户使用写作空间。
当用户手动为另一个文件夹调用 cw-setup-project 时,应提供引导,而不是假定他们想立即创建新的配置文件。
交接
报告写作空间的路径、已创建的内容、任何可选的受众指南或共享来源、因已存在而跳过的内容,以及下一步可采取的有效操作。