Back to Details

secondbrain-note

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Create Note

Create Note

Capture knowledge, ideas, and thoughts with tagging support.
捕捉知识、创意与想法，支持标签分类。

Prerequisites

前提条件

Verify Notes entity is enabled:
  1. Check for 
    .claude/data/notes/records.yaml
  2. If not found, suggest enabling notes via 
    secondbrain-init
    or 
    secondbrain-entity
验证Notes实体已启用：
  1. 检查是否存在
    .claude/data/notes/records.yaml
    文件
  2. 若未找到，建议通过
    secondbrain-init
    或
    secondbrain-entity
    启用笔记功能

Workflow

工作流程

Step 1: Gather Information

步骤1：收集信息

Collect from user or conversation context:
  1. Title — Brief, descriptive title
  2. Content — Main content (can be from conversation)
  3. Tags (optional) — Categorization tags
从用户或对话上下文收集以下内容：
  1. 标题 — 简洁、具有描述性的标题
  2. 内容 — 主要内容（可来自对话）
  3. 标签（可选） — 用于分类的标签

Step 2: Generate Note ID

步骤2：生成笔记ID

Date-based ID format: 
YYYY-MM-DD-<title-slug>
Example: 
2026-01-15-kubernetes-deployment-patterns
基于日期的ID格式：
YYYY-MM-DD-<title-slug>
示例：
2026-01-15-kubernetes-deployment-patterns

Step 3: Create Note Document

步骤3：创建笔记文档

Filename: 
docs/notes/YYYY-MM-DD-<slug>.md
Frontmatter:
yaml
---
id: 2026-01-15-my-note
title: My Note Title
created: 2026-01-15
tags: [tag1, tag2]
status: active
---
Content:
markdown
undefined
文件名： 
docs/notes/YYYY-MM-DD-<slug>.md
前置元数据：
yaml
---
id: 2026-01-15-my-note
title: My Note Title
created: 2026-01-15
tags: [tag1, tag2]
status: active
---
文档内容：
markdown
undefined

My Note Title

My Note Title

Summary

摘要

Brief overview...
简要概述...

Content

正文

Main content here...
主要内容...

References

参考资料

  • Links to related resources
  • 相关资源链接

Related

关联内容

  • Links to related notes, ADRs, etc.
undefined
  • 关联笔记、ADR等的链接
undefined

Step 4: Update Records

步骤4：更新记录

Add entry to 
.claude/data/notes/records.yaml
:
yaml
- id: "2026-01-15-my-note"
  title: "My Note Title"
  created: 2026-01-15
  file: docs/notes/2026-01-15-my-note.md
  tags: [tag1, tag2]
  status: active
在
.claude/data/notes/records.yaml
中添加条目：
yaml
- id: "2026-01-15-my-note"
  title: "My Note Title"
  created: 2026-01-15
  file: docs/notes/2026-01-15-my-note.md
  tags: [tag1, tag2]
  status: active

Step 5: Sidebar Note

步骤5：侧边栏说明

DO NOT manually add notes to VitePress sidebar.
Notes are automatically listed via the 
EntityTable
component on 
docs/notes/index.md
, which reads from 
.claude/data/notes/records.yaml
. No sidebar modification needed.
请勿手动将笔记添加到VitePress侧边栏。
笔记会通过
docs/notes/index.md
页面上的
EntityTable
组件自动列出，该组件读取
.claude/data/notes/records.yaml
中的内容，无需修改侧边栏。

Step 6: Confirm Creation

步骤6：创建确认

undefined
undefined

Note Created

笔记已创建

ID: 2026-01-15-kubernetes-deployment-patterns Title: Kubernetes Deployment Patterns Tags: kubernetes, deployment, devops File: docs/notes/2026-01-15-kubernetes-deployment-patterns.md
The note has been created and is ready for editing.
undefined
ID： 2026-01-15-kubernetes-deployment-patterns 标题： Kubernetes Deployment Patterns 标签： kubernetes, deployment, devops 文件： docs/notes/2026-01-15-kubernetes-deployment-patterns.md
笔记已创建完成，可进行编辑。
undefined

Tags

标签

Tags help organize notes for discovery. Common patterns:
CategoryExample Tags
Technology
kubernetes
, 
react
, 
python
Domain
architecture
, 
security
, 
performance
Type
howto
, 
reference
, 
research
Project
project-x
, 
migration
, 
refactor
标签有助于整理笔记以便查找，常见分类模式：
分类示例标签
技术领域
kubernetes
, 
react
, 
python
业务领域
architecture
, 
security
, 
performance
笔记类型
howto
, 
reference
, 
research
项目相关
project-x
, 
migration
, 
refactor

Status Values

状态值

  • active
    — Current, relevant note
  • archived
    — No longer current but preserved
  • active
    — 当前有效的相关笔记
  • archived
    — 不再有效但需保留的笔记

Additional Resources

额外资源

  • references/note-formats.md
     — Detailed note templates and formatting patterns
  • references/note-formats.md
     — 详细的笔记模板与格式规范

Tips

小贴士

  1. Be specific — Titles should indicate content at a glance
  2. Add context — Include why this is important, not just what
  3. Link liberally — Connect to related notes and external resources
  4. Tag consistently — Use established tags when possible
  5. Review periodically — Archive notes that are no longer relevant
  1. 具体明确 — 标题应能让人一眼了解内容
  2. 添加背景 — 不仅记录内容，还要说明其重要性
  3. 广泛链接 — 关联相关笔记与外部资源
  4. 标签一致 — 尽可能使用已有的标准标签
  5. 定期回顾 — 将不再相关的笔记归档