cw-official-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Official Documentation

官方文档

Create canonical, sourced wiki pages for your story's characters, locations, events, and lore.

为你的故事角色、地点、事件和设定创建规范、有来源依据的维基页面。

Purpose

目的

Build authoritative documentation (wiki-style pages) that serves as "single source of truth" for your fictional world. These are polished, cited, encyclopedic reference pages suitable for readers - NOT working notes or brainstorming.

Can be created before or during writing for worldbuilding, lore, and reference material that won't all appear in the story itself.

构建权威的文档（维基风格页面），作为虚构世界的「单一事实来源」。这些是经过打磨、带有引用的百科式参考页面，适合读者阅读——而非工作笔记或头脑风暴内容。

可在写作前或写作过程中创建，用于构建不会全部出现在故事本身中的世界观、设定和参考资料。

Documentation vs Brainstorm Notes

文档与头脑风暴笔记的区别

The key distinction: Documentation = you've decided and it's polished enough to show someone. Brainstorm = you're still figuring it out.

Documentation	Brainstorm
Single version	Multiple options coexist
Polished	Skeletal
No [TBD] markers	Source tags throughout
Reader-ready	Author's working notes
Finalized decisions	Exploratory

核心差异： 文档 = 已确定内容，且打磨至可展示给他人的程度。头脑风暴 = 仍在探索阶段的内容。

文档	头脑风暴
单一版本	存在多种备选方案
经过打磨	框架性内容
无[TBD]标记	全程带有来源标签
适合读者阅读	作者的工作笔记
已确定的决策	探索性内容

Core Principles

核心原则

1. Canonical Only

1. 仅包含规范内容

Wiki pages contain ONLY confirmed information:

Facts from written chapters OR finalized worldbuilding
Details the author has decided
Single authoritative version

维基页面仅包含已确认的信息：

已撰写章节中的事实，或已最终确定的世界观设定
作者已敲定的细节
单一权威版本

2. Citations Required

2. 必须添加引用

Every claim needs a source:

Chapter references for story facts
"Worldbuilding document: [filename]" for lore created before writing
Scene-specific citations when possible

每一项表述都需要来源：

故事事实标注章节参考
写作前创建的设定标注「世界观文档：[文件名]」
尽可能标注具体场景的引用

3. Encyclopedic Tone

3. 百科式语气

Write like a reference work:

Third person
Past tense for completed events, present for current state
Neutral, factual tone

采用参考资料的写作风格：

第三人称
已完成事件用过去时，当前状态用现在时
中立、客观的语气

Flexible Structure

灵活的结构

Documentation pages aren't templates to fill in - structure should fit the content.

Some character pages need detailed backstory, others don't. Some locations are just "a tavern in the capital" - that's one paragraph, not 12 sections. Some magic systems need elaborate rules, others are intentionally mysterious.

Include what matters, skip what doesn't. Trust your judgment.

See references/page-patterns.md for common patterns and examples - not mandatory structures.

文档页面不是需要填充的模板——结构应适配内容。

有些角色页面需要详细的背景故事，有些则不需要。有些地点只是「首都的一家酒馆」——只需一段文字，而非12个章节。有些魔法系统需要详尽的规则，有些则故意设定得神秘莫测。

只保留重要内容，跳过无关部分。相信你的判断。

可查看references/page-patterns.md获取常见模式和示例——这些不是强制结构。

Creating Documentation Pages

创建文档页面的步骤

Decide what needs documenting - Character? Location? System? Event?
Choose relevant structure - See references/page-patterns.md for common patterns
Write what matters - Skip irrelevant sections, adapt structure to content
Add citations - See references/citation-guide.md for formats
Cross-reference - Link related pages for discoverability

Structure adapts to content - not every page needs every section.

确定需要文档化的内容——角色？地点？系统？事件？
选择合适的结构——查看references/page-patterns.md获取常见模式
撰写重要内容——跳过无关章节，根据内容调整结构
添加引用——查看references/citation-guide.md获取格式规范
交叉引用——链接相关页面以提升可发现性

结构适配内容——并非每个页面都需要所有章节。

Using Web Search

使用网络搜索

Search when helpful for:

Verifying real-world facts your story references
Research for worldbuilding elements
Finding similar fictional documentation/wikis for inspiration
Checking naming conventions or terminology

在以下场景中可使用搜索：

验证故事中引用的现实世界事实
为世界观设定元素做调研
寻找类似的虚构文档/维基以获取灵感
检查命名规范或术语

Timing

时间安排

You can write documentation pages BEFORE writing story chapters - just ensure content is finalized and presentation-ready, not exploratory.

For worldbuilding/lore: Finalize concept → Create documentation page → Use while writing

For story events: Write chapters → Document what happened → Create documentation page

你可以在撰写故事章节之前就编写文档页面——只需确保内容已最终确定且呈现就绪，而非探索性内容。

对于世界观/设定： 敲定概念 → 创建文档页面 → 写作时使用

对于故事事件： 撰写章节 → 记录发生的内容 → 创建文档页面

Teaching Example: Simple vs Complex

教学示例：简单 vs 复杂

Not every page needs elaborate structure:

Simple location (totally valid):

markdown

---
title: The Broken Wheel Tavern
type: location
---

并非每个页面都需要复杂结构：

简单地点（完全有效）：

markdown

---
title: The Broken Wheel Tavern
type: location
---

The Broken Wheel Tavern

A run-down tavern in the merchant quarter of Kingsport. Known for cheap ale and cheaper rooms.

The protagonist meets their contact here in Chapter 3.

References:

Chapter 3: First meeting scene


**Complex character (when needed):**
```markdown
---
title: Marcus Webb
type: character
status: alive
---

A run-down tavern in the merchant quarter of Kingsport. Known for cheap ale and cheaper rooms.

The protagonist meets their contact here in Chapter 3.

References:

Chapter 3: First meeting scene


**复杂角色（必要时）：**
```markdown
---
title: Marcus Webb
type: character
status: alive
---

Marcus Webb

Former military intelligence officer turned information broker in Kingsport.

Background

Served 15 years in the Royal Intelligence Service before a scandal forced his resignation. Now operates independently, selling information to whoever can pay.

Appearance

Mid-40s, graying hair, military bearing despite civilian clothes. Distinctive scar across left eyebrow from field injury.

Role in Story

Acts as information source for the protagonist. Provides critical intelligence about the conspiracy in Chapter 3, then becomes recurring ally throughout Arc 1.

Key Relationships

Sarah Chen: Former colleague, maintains uneasy trust
The protagonist: Professional relationship, provides information for payment

References:

Chapter 3: First introduction, provides intel
Chapter 7: Warns protagonist about surveillance
Chapter 12: Reveals his own involvement in the conspiracy


**Both are valid** - structure fits what needs documenting.

Sarah Chen: Former colleague, maintains uneasy trust
The protagonist: Professional relationship, provides information for payment

References:

Chapter 3: First introduction, provides intel
Chapter 7: Warns protagonist about surveillance
Chapter 12: Reveals his own involvement in the conspiracy


**两者均有效**——结构适配需要文档化的内容。

Skills are Composable

技能可组合使用

Feel free to combine with other skills when helpful (e.g., using cw-brainstorming while exploring worldbuilding before finalizing into documentation pages).

如有需要，可与其他技能结合使用（例如，在探索世界观设定尚未最终确定时，结合cw-brainstorming技能，之后再整理为文档页面）。

File Placement (Claude Code)

文件存放位置（Claude Code）

Check project documentation for organization
Common locations:
```
docs/
```
,
```
wiki/
```
,
```
docs/reference/
```
,
```
reference/
```
Match existing naming conventions
Ask if unclear

查看项目文档了解组织方式
常见位置：
```
docs/
```
,
```
wiki/
```
,
```
docs/reference/
```
,
```
reference/
```
匹配现有的命名规范
如有疑问可询问

Resources

资源

See:

```
references/page-patterns.md
```
- Common patterns and examples (not templates)
```
references/citation-guide.md
```
- How to cite sources
```
references/example-pages.md
```
- Complete example pages at different complexity levels

参考：

```
references/page-patterns.md
```
——常见模式和示例（非强制模板）
```
references/citation-guide.md
```
——引用格式指南
```
references/example-pages.md
```
——不同复杂度的完整示例页面