cw-setup-project

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Set Up A Writing Home

设置写作家园

Create one portable folder that can travel independently of the plugin and contains the context and working surfaces Compound Writing needs.
创建一个可独立于插件迁移的便携文件夹,其中包含Compound Writing所需的上下文和工作界面。

Resolve The Target

确定目标位置

  • Use the path or folder name the user supplied.
  • If the destination is unclear and choosing it would create the writing home in a materially different place, ask for the path.
  • Read existing workspace instructions before writing.
  • Never create writing-home files inside the installed plugin or runtime cache.
  • 使用用户提供的路径或文件夹名称。
  • 如果目标位置不明确,且自行选择会导致写作家园被创建在完全不同的位置,需向用户询问路径。
  • 写入前先读取现有工作区说明。
  • 切勿在已安装的插件或运行时缓存内创建写作家园文件。

Create The Writing Home

创建写作家园

Create this exact minimum structure:
text
writing-home/
├── VOICE.md
├── STYLE.md
├── examples/
│   └── README.md
└── drafts/
    └── README.md
Run the bundled creator by resolving it relative to this
SKILL.md
; do not assume the user's working directory is the plugin root:
bash
python3 "<plugin-root>/skills/cw-setup-project/scripts/create_project.py" "/path/to/writing-home"
The script copies the canonical templates from
defaults/project-template/
. It may create a new folder or populate an empty folder. It refuses to modify a non-empty folder by default and never overwrites files.
For an existing folder, inspect it first. If the user explicitly wants the Compound Writing structure added, run:
bash
python3 "<plugin-root>/skills/cw-setup-project/scripts/create_project.py" "/path/to/writing-home" --add-missing
--add-missing
creates only absent items. Preserve every existing file and convention.
创建如下标准最小结构:
text
writing-home/
├── VOICE.md
├── STYLE.md
├── examples/
│   └── README.md
└── drafts/
    └── README.md
通过相对于此
SKILL.md
解析的方式运行内置的创建工具;不要假设用户的工作目录是插件根目录:
bash
python3 "<plugin-root>/skills/cw-setup-project/scripts/create_project.py" "/path/to/writing-home"
该脚本会从
defaults/project-template/
复制标准模板。它可以创建新文件夹或为空文件夹填充内容。默认情况下,它拒绝修改非空文件夹,且绝不会覆盖文件。
对于现有文件夹,请先检查其内容。如果用户明确要求添加Compound Writing结构,请运行:
bash
python3 "<plugin-root>/skills/cw-setup-project/scripts/create_project.py" "/path/to/writing-home" --add-missing
--add-missing
仅创建缺失的项目。保留所有现有文件和约定。

Optional Audience Guide

可选受众指南

When the writer asks to establish audience context and no maintained shared guide is already named, add
--with-audience
to the creator command. For an existing writing home, combine it with
--add-missing
after inspection. This adds the generic
AUDIENCE.md
template without overwriting any existing file.
If a shared audience guide already governs the work, reference that guide from project instructions instead of creating a duplicate. A local
AUDIENCE.md
is optional; do not add one or interrupt writing merely because it is missing. Use the audience resolution rules in
../../references/context-contract.md
.
当写作者要求建立受众上下文,且没有已命名的维护中共享指南时,在创建命令中添加
--with-audience
。对于现有写作家园,请在检查后将其与
--add-missing
结合使用。这会添加通用的
AUDIENCE.md
模板,且不会覆盖任何现有文件。
如果已有共享受众指南适用于该作品,请在项目说明中引用该指南,而不是创建重复文件。本地
AUDIENCE.md
是可选的;不要仅仅因为缺少该文件就添加它或中断写作。请遵循
../../references/context-contract.md
中的受众解析规则。

Keep The Split Clear

保持职责划分清晰

  • VOICE.md
    answers: How should the sentences sound? Put syntax, diction, and tone here, including cadence, rhythm, register, punctuation, and verbal tics.
  • STYLE.md
    answers: What must the article do, contain, and prove? Put argument, evidence, article structure, substantive standards, audience promise, and publication-readiness criteria here.
  • Optional
    AUDIENCE.md
    answers: Who are we writing for, and what may engage them? Keep reader situations, knowledge, wants, interests, resistance, and their evidence here; use a named shared guide when one exists.
  • examples/
    holds curated positive and negative examples. Examples are evidence for the written rules, not rules by themselves.
  • drafts/
    holds one folder per piece:
    drafts/<piece-slug>/
    . Keep that piece's notes, research, outline, draft versions, and reviews together.
Never put argument, evidence, structure, or publication-readiness rules in
VOICE.md
. Never put word choice, sentence construction, cadence, or tone rules in
STYLE.md
. Split mixed feedback into separate rules.
Do not create
TASTE.md
,
context.md
,
published/
, or
.status.yaml
as part of setup.
  • VOICE.md
    回答:句子应该是什么风格? 在此处放置句法、措辞和语气相关规则,包括节奏、韵律、语域、标点和语言习惯。
  • STYLE.md
    回答:文章必须完成什么、包含什么、证明什么? 在此处放置论点、论据、文章结构、实质性标准、受众承诺和发布就绪标准。
  • 可选的
    AUDIENCE.md
    回答:我们为谁写作,什么内容能吸引他们? 在此处记录读者的处境、知识储备、需求、兴趣、抵触点及相关依据;如果存在已命名的共享指南,请使用该指南。
  • examples/
    存放精选的正面和反面示例。示例是书面规则的依据,而非规则本身。
  • drafts/
    中每篇作品对应一个文件夹:
    drafts/<piece-slug>/
    。将该作品的笔记、研究资料、大纲、草稿版本和评审意见放在一起。
切勿将论点、论据、结构或发布就绪规则放在
VOICE.md
中。切勿将选词、句子结构、节奏或语气规则放在
STYLE.md
中。将混合反馈拆分为独立的规则。
设置过程中不要创建
TASTE.md
、
context.md
、
published/
或
.status.yaml
。

Migrate A Legacy Project

迁移旧项目

When
TASTE.md
exists:
  1. Read it with the existing project instructions.
  2. Route syntax, diction, and tone rules to
    VOICE.md
    .
  3. Route argument, evidence, article structure, substantive standards, and publication-readiness rules to
    STYLE.md
    .
  4. Route durable reader knowledge to a maintained
    AUDIENCE.md
    when requested; use an existing shared guide rather than creating a duplicate. Flag mixed or conflicting guidance.
  5. Show the migration summary before changing ambiguous or high-authority guidance.
  6. Preserve
    TASTE.md
    until the user explicitly approves its deletion or archival.
当存在
TASTE.md
时:
  1. 结合现有项目说明读取该文件。
  2. 将句法、措辞和语气规则归类到
    VOICE.md
    。
  3. 将论点、论据、文章结构、实质性标准和发布就绪规则归类到
    STYLE.md
    。
  4. 如有需要,将持久化读者知识归类到维护中的
    AUDIENCE.md
    ;使用现有共享指南而非创建重复文件。标记混合或冲突的指引。
  5. 在修改模糊或高权威性的指引前,展示迁移摘要。
  6. 保留
    TASTE.md
    ,直到用户明确批准删除或归档。

Begin The Guides

启动指南配置

After first-run setup, begin
cw-onboarding
so the writer can add a useful first version of both guides from a short conversation, existing writing, or the work already in progress. Do not block use of the writing home on completing either profile.
When the user invoked
cw-setup-project
manually for an additional folder, offer onboarding rather than assuming they want a new profile immediately.
首次运行设置后,启动
cw-onboarding
,以便写作者可以通过简短对话、现有作品或正在进行的工作,添加两个指南的实用初始版本。不要因为未完成任一配置文件就阻止使用写作家园。
当用户为额外文件夹手动调用
cw-setup-project
时,主动提供入门引导,而不是假设他们立即需要新的配置文件。

Handoff

交接说明

Report the writing-home path, the created surfaces, any optional audience guide or shared source, anything skipped because it already existed, and the next useful step.
报告写作家园路径、已创建的工作界面、所有可选的受众指南或共享来源、因已存在而被跳过的内容,以及下一步的实用操作。