working-docs

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Obsidian Working Documents

Obsidian工作文档管理

Manage working documents in the Obsidian vault for cross-session, cross-project memory.

Vault path:

~/Documents/Obsidian Vault/

Prefer the

obsidian:obsidian-cli

skill for vault interactions (read, create, search, manage notes). Fall back to reading and writing the vault path directly only if that skill is unavailable.

管理Obsidian Vault中的工作文档，实现跨会话、跨项目的记忆留存。

Vault路径:

~/Documents/Obsidian Vault/

优先使用

obsidian:obsidian-cli

技能进行Vault交互（读取、创建、搜索、管理笔记）。仅当该技能不可用时，才直接读写Vault路径作为备选方案。

When to Use

使用场景

Multi-step or multi-session tasks — create a working document
Starting work on a topic that may span sessions — check for existing docs first
Research findings, implementation plans, PRDs — persistent Claude docs
Quick findings during debugging or exploration — inbox dump

Skip for one-off questions, quick fixes, or trivial tasks.

多步骤或跨会话任务——创建工作文档
开始涉及跨会话主题的工作——先检查是否已有相关文档
研究成果、实施计划、PRD——存入持久化Claude文档
调试或探索过程中的快速发现——存入Inbox临时记录

跳过场景：一次性问题、快速修复或琐碎任务。

Two-Tier System

双层文档系统

Inbox (ephemeral, quick dumps)

Inbox（临时记录，快速存储）

Location:
```
~/Documents/Obsidian Vault/Inbox/
```
Format:
```
YYYY-MM-DD <scope> - <Description>.md
```
Scope: freeform short topic —
```
react
```
,
```
auth
```
,
```
xp-debugger
```
,
```
contentstudio
```
Always
```
Draft
```
status
Promote to
```
Dev/Claude/
```
when structured, or delete when stale

位置:
```
~/Documents/Obsidian Vault/Inbox/
```
命名格式:
```
YYYY-MM-DD <范围> - <描述>.md
```
范围: 自由格式的简短主题——例如
```
react
```
、
```
auth
```
、
```
xp-debugger
```
、
```
contentstudio
```
状态始终为
```
Draft
```
（草稿）
内容结构化后升级至
```
Dev/Claude/
```
目录，内容过时则删除

Claude (persistent working documents)

Claude（持久化工作文档）

Location:
```
~/Documents/Obsidian Vault/Dev/Claude/
```
Format:
```
<Type> - <Scope> - <Description>.md
```
Type:
```
PRD
```
|
```
Plan
```
|
```
Note
```
|
```
Research
```
|
```
Log
```
Scope: freeform — repo name (
```
app-contentstudio
```
), skill name (
```
init-permissions
```
), tool name (
```
xp-debugger
```
), or
```
general
```
No date in filename — dates in frontmatter only (Created/Updated)
Status:
```
Draft
```
|
```
Active
```
|
```
Completed
```
|
```
Archived
```

位置:
```
~/Documents/Obsidian Vault/Dev/Claude/
```
命名格式:
```
<类型> - <范围> - <描述>.md
```
类型:
```
PRD
```
|
```
Plan
```
（计划） |
```
Note
```
（笔记） |
```
Research
```
（研究） |
```
Log
```
（日志）
范围: 自由格式——仓库名称（
```
app-contentstudio
```
）、技能名称（
```
init-permissions
```
）、工具名称（
```
xp-debugger
```
）或
```
general
```
（通用）
文件名不含日期——日期仅在前置元数据中记录（创建时间/更新时间）
状态:
```
Draft
```
（草稿） |
```
Active
```
（活跃） |
```
Completed
```
（已完成） |
```
Archived
```
（已归档）

Index

索引文件

The index file at

~/Documents/Obsidian Vault/Dev/Claude/Claude Working Docs.md

lists all persistent Claude docs. Update it whenever you create, promote, or complete a document.

索引文件位于

~/Documents/Obsidian Vault/Dev/Claude/Claude Working Docs.md

，列出所有持久化Claude文档。创建、升级或完成文档时需同步更新该索引。

Document Header Template

文档页眉模板

Every working document (both Inbox and Claude) uses this header:

markdown

undefined

所有工作文档（Inbox和Claude文档）均使用以下页眉：

markdown

undefined

[Description]

[描述]

#claude #[type] #[scope]

Project: [name] Repo: [url or path] Created: YYYY-MM-DD Updated: YYYY-MM-DD Status: Draft | Active | Completed | Archived


For Inbox docs, status is always `Draft`. Omit `**Repo**` if not project-specific.

#claude #[type] #[scope]

Project: [名称] Repo: [链接或路径] Created: YYYY-MM-DD Updated: YYYY-MM-DD Status: Draft | Active | Completed | Archived


Inbox文档的状态始终为`Draft`。若非项目相关文档，可省略`**Repo**`字段。

Operations

操作流程

Find Existing Documents

查找已有文档

Before creating a new document, always check if one already exists. Search in order:

Read the index:

~/Documents/Obsidian Vault/Dev/Claude/Claude Working Docs.md

Glob by type:

~/Documents/Obsidian Vault/Dev/Claude/Note - *

Glob by scope:

~/Documents/Obsidian Vault/Dev/Claude/* - app-contentstudio - *

Inbox by date:

~/Documents/Obsidian Vault/Inbox/2026-03*

Grep for status: search

**Status**: Active

~/Documents/Obsidian Vault/Dev/Claude/

If a matching document exists, update it instead of creating a new one.

创建新文档前，需先检查是否存在同类文档。搜索顺序如下：

读取索引文件：

~/Documents/Obsidian Vault/Dev/Claude/Claude Working Docs.md

按类型全局搜索：

~/Documents/Obsidian Vault/Dev/Claude/Note - *

按范围全局搜索：

~/Documents/Obsidian Vault/Dev/Claude/* - app-contentstudio - *

按日期搜索Inbox：

~/Documents/Obsidian Vault/Inbox/2026-03*

按状态搜索：在

~/Documents/Obsidian Vault/Dev/Claude/

目录中搜索

**Status**: Active

若存在匹配文档，直接更新而非创建新文档。

Create Inbox Note

创建Inbox笔记

Use for quick dumps during active work — findings, partial research, debug notes.

Determine scope from current context (repo name, topic, tool)

Write to

~/Documents/Obsidian Vault/Inbox/YYYY-MM-DD <scope> - <Description>.md

Use the header template with
```
Status: Draft
```
Write content below the
```
---
```
separator

用于工作过程中的快速记录——例如发现的问题、部分研究内容、调试笔记等。

根据当前上下文确定范围（仓库名称、主题、工具）

写入路径：

~/Documents/Obsidian Vault/Inbox/YYYY-MM-DD <范围> - <描述>.md

使用页眉模板，设置
```
Status: Draft
```
在
```
---
```
分隔符下方写入内容

Create Claude Document

创建Claude文档

Use for structured, persistent documents that will be referenced across sessions.

Check for existing docs first (see Find above)
Determine type (
```
PRD
```
,
```
Plan
```
,
```
Note
```
,
```
Research
```
,
```
Log
```
) from content purpose
Determine scope from project/topic context

Write to

~/Documents/Obsidian Vault/Dev/Claude/<Type> - <Scope> - <Description>.md

Use the header template with
```
Status: Draft
```
or
```
Active
```
Write content below the
```
---
```
separator
Update the index file — add a line entry for the new document

用于结构化、需跨会话引用的持久化文档。

先检查是否存在同类文档（参考查找已有文档部分）
根据内容用途确定类型（
```
PRD
```
、
```
Plan
```
、
```
Note
```
、
```
Research
```
、
```
Log
```
）
根据项目/主题上下文确定范围

写入路径：

~/Documents/Obsidian Vault/Dev/Claude/<Type> - <Scope> - <Description>.md

使用页眉模板，设置状态为
```
Draft
```
或
```
Active
```
在
```
---
```
分隔符下方写入内容
更新索引文件——添加新文档的条目

Update Existing Document

更新已有文档

Read the document
Update content as needed
Bump
```
**Updated**: YYYY-MM-DD
```
in frontmatter to today's date
Update
```
**Status**
```
if it changed (e.g.,
```
Draft
```
→
```
Active
```
)

读取目标文档
根据需要更新内容
将前置元数据中的
```
**Updated**: YYYY-MM-DD
```
修改为当前日期
若状态变更，同步更新
```
**Status**
```
（例如
```
Draft
```
→
```
Active
```
）

Promote from Inbox to Claude

从Inbox升级至Claude文档

When an Inbox note has grown into structured content worth keeping long-term:

Read the Inbox note
Determine the appropriate Type and Scope for Claude naming

Write the new file at

~/Documents/Obsidian Vault/Dev/Claude/<Type> - <Scope> - <Description>.md

Update the header: set proper status, bump
```
**Updated**
```
date
Delete the original Inbox file
Update the index file

当Inbox笔记已形成结构化内容且需长期留存时：

读取目标Inbox笔记
确定适合Claude文档的类型和范围

将内容写入新路径：

~/Documents/Obsidian Vault/Dev/Claude/<Type> - <Scope> - <Description>.md

更新页眉：设置正确状态，更新
```
**Updated**
```
日期
删除原Inbox文件
更新索引文件

Complete a Document

标记文档为已完成

When the work described in a document is done:

Update
```
**Status**: Completed
```
and bump
```
**Updated**
```
date
Update the index file — mark as completed or move to a completed section

当文档描述的工作已完成时：

将
```
**Status**
```
修改为
```
Completed
```
，并更新
```
**Updated**
```
日期
更新索引文件——标记为已完成或移至已完成章节

Archive a Document

归档文档

When a completed document is no longer actively referenced:

Update
```
**Status**: Archived
```
and bump
```
**Updated**
```
date
Update the index file accordingly

当已完成文档不再需要主动引用时：

将
```
**Status**
```
修改为
```
Archived
```
，并更新
```
**Updated**
```
日期
同步更新索引文件