返回顶部
m

memory-notes记忆笔记写法

How to write well-structured Basic Memory notes: frontmatter, observations with semantic categories, relations with wiki-links, and best practices for building a rich knowledge graph. Use when creating or improving notes.

作者: admin | 来源: ClawHub
源自
ClawHub
版本
V 0.1.0
安全检测
已通过
391
下载量
免费
免费
0
收藏
概述
安装方式
版本历史

memory-notes

记忆笔记

编写结构良好的笔记,Basic Memory 可将其解析为可搜索的知识图谱。每条笔记都是一个 Markdown 文件,包含三个关键部分:前置元数据、观察记录和关联关系。

笔记结构

markdown



title: API 设计决策
tags: [api, 架构, 决策]


API 设计决策

API 团队在第一季度评估了公开 API 的多种方案。在原型开发了 REST 和 GraphQL 两种方案后,团队选择了 REST,原因是其拥有更广泛的生态系统支持和更简单的缓存语义。本条笔记记录了关键决策及其理由,以及尚待解决的开放问题。

观察记录

  • - [决策] 使用 REST 而非 GraphQL,以保持简洁性 #api
  • [需求] 必须从第一天起支持版本管理
  • [风险] 公开端点需要限流

关联关系

  • - 实现 [[API 规范]]
  • 依赖 [[认证系统]]
  • 关联 [[性能需求]]

前置元数据

每条笔记以 YAML 前置元数据开头:

yaml



title: 笔记标题 # 必填 — 成为知识图谱中的实体名称
tags: [标签1, 标签2] # 可选 — 用于组织和筛选
type: note # 可选 — 默认为 note,可使用自定义类型配合模式
permalink: 自定义路径 # 可选 — 省略时从标题自动生成


  • - title 必须与正文中的 # 标题 一致
  • 标签可搜索,有助于发现
  • 自定义 type 值(任务、会议、人员等)可与模式系统配合使用。有关定义模式、验证笔记是否符合模式以及检测偏差,请参阅 memory-schema 技能。
  • permalink 从 title 和 directory 自动生成。例如,目录 specs 中的标题 API Design Decisions 会生成 permalink specs/api-design-decisions 和记忆 URL memory://specs/api-design-decisions。如果未指定目录,则 permalink 仅为短横线命名格式的标题。Permalink 在文件移动时保持稳定。你很少需要手动设置。

注意: 使用 writenote 时,你不需要自己编写前置元数据。title、tags、notetype 和 metadata 是单独的参数 — Basic Memory 会自动生成前置元数据。你的 content 参数只是以 # 标题 开头的 Markdown 正文。

正文/上下文

标题和观察记录部分之间的自由格式 Markdown。这是笔记的核心 — 在此处尽情书写:

  • - 背景、动机和历史
  • 对发生事件及其重要性的详细解释
  • 分析、推理和权衡的考量
  • 他人(或 AI)后续理解本条笔记所需的上下文

编写完整、充实的散文。Basic Memory 的搜索会检索笔记正文中的相关片段,因此更长、更丰富的上下文使笔记更易于发现,且在被找到时更有价值。不要将所有内容都简化为要点 — 讲述故事。

观察记录

观察记录是分类的事实 — 知识的原子单位。每条观察记录都会成为知识图谱中可搜索的实体。

语法

  • - [类别] 观察内容 #可选标签
  • - 方括号 定义语义类别
  • 内容 是事实、决策、见解或备注
  • 井号标签(可选)添加额外的元数据用于筛选

类别是任意的

方括号中的类别是自由格式的 — 使用任何对观察记录有意义的标签。没有固定列表。唯一的规则是 [类别] 内容 的语法。项目内的一致性有助于搜索,但可以自由创造类别。

以下示例展示了其范围:

  • - [决策] 使用 PostgreSQL 作为主数据存储
  • [风险] 第三方 API 没有 SLA 保证
  • [技术] 重试逻辑使用指数退避 #弹性
  • [问题] 我们是否应该在数据库层面支持多租户?
  • [偏好] 新项目使用 Bun 而非 Node
  • [经验] 始终在服务端验证 Webhook 签名
  • [状态] 活跃
  • [风味] 埃塞俄比亚咖啡豆最适合浅烘焙

观察记录技巧

  • - 每条观察记录只包含一个事实。 不要将多个想法塞进一行。
  • 要具体。 [决策] 使用 JWT 不如 [决策] 使用 15 分钟过期的 JWT 进行 API 认证 有用。
  • 使用标签处理跨领域关注点。 [风险] 需要限流 #api #安全 使该记录在两种主题下都可被找到。
  • 类别是可查询的。 search_notes([决策]) 可以找到知识库中的所有决策。

关联关系

关联关系在知识图谱中创建边,将笔记相互链接。这是你在单个笔记之外构建结构的方式。

语法

  • - 关系类型 [[目标笔记标题]]
  • - 关系类型 是描述性动词或短语(按惯例使用蛇形命名法)
  • 双括号 [[...]] 通过标题或 permalink 标识目标笔记
  • 关联关系是有方向的:本条笔记 → 目标笔记

关系类型

类型用途示例
实现一个事物实现另一个事物- 实现 [[认证规范]]
需要
依赖关系 | - 需要 [[数据库设置]] | | 关联 | 一般连接 | - 关联 [[性能笔记]] | | 组成部分 | 层级/组成关系 | - 组成部分 [[后端架构]] | | 扩展 | 增强或细化 | - 扩展 [[基础配置]] | | 搭配 | 协同工作的事物 | - 搭配 [[前端客户端]] | | 灵感来源 | 源材料 | - 灵感来源 [[CRDT 研究论文]] | | 替代 | 取代另一条笔记 | - 替代 [[旧认证设计]] | | 依赖 | 运行时/构建依赖 | - 依赖 [[MCP SDK]] | | 对比 | 替代方案 | - 对比 [[GraphQL 方案]] |

内联关联关系

笔记正文中任何位置的 Wiki 链接 — 不仅仅是关联关系部分 — 也会创建图谱边:

markdown
我们评估了 [[GraphQL 方案]] 但决定不采用,因为团队对 REST 更有经验。请参阅 [[API 规范]] 了解完整约定。

这些会自动创建 引用 关系。对于明确、类型化的关系,请使用关联关系部分;对于自然的散文引用,请使用内联链接。

关联关系技巧

  • - 自由链接。 关联关系是将孤立笔记转变为知识图谱的关键。如有疑问,就添加链接。
  • 如果目标笔记尚不存在,请创建它们。 [[未来主题]] 是有效的 — BM 会在创建该笔记时解析它。
  • 使用 buildcontext 进行遍历。 buildcontext(url=memory://note-title) 会跟随关联关系收集连接的知识。
  • 自定义关系类型也没问题。 由...教授、阻塞、在...中测试 — 使用任何描述性的类型。

记忆 URL

每条笔记都可以通过 memory:// URL 寻址,该 URL 由其 permalink 构建。这些 URL 是你以编程方式导航知识图谱的方式。

URL 模式

memory://api-design-decisions # 按 permalink(标题 → 短横线命名)
memory://docs/authentication # 按文件路径
memory://docs/authentication.md # 带扩展名(同样有效)
memory://auth* # 通配符前缀
memory://docs/* # 通配符后缀
memory://project/*/requirements # 路径通配符

项目作用域 URL

在多项目设置中,使用项目名称作为前缀:

memory://main/specs/api-design # main 项目,specs/api-design 路径
memory://research/papers/crdt # research 项目

第一个路径段会与已知项目名称进行匹配。如果匹配,则将其用作项目作用域。否则,URL 会在默认项目中解析。

使用记忆 URL

记忆 URL 可与 build_context 配合使用,通过遍历关联关系来组装相关知识:

python

获取一条笔记及其连接上下文


build_context(url=memory://api-design-decisions)

通配符 — 收集所有文档

build_context(url=memory://docs/*)

按 permalink 直接读取

read_note(identifier=memory://api-design-decisions)

创建笔记之前

在创建新笔记之前,始终先搜索 Basic Memory。重复内容会碎片化你的知识图谱 — 更新现有笔记几乎总是比创建第二条笔记更好。

使用多种变体进行搜索

单次搜索往往会遗漏。尝试全名、缩写、首字母缩略

标签

skill ai

通过对话安装

该技能支持在以下平台通过对话安装:

OpenClaw WorkBuddy QClaw Kimi Claude

方式一:安装 SkillHub 和技能

帮我安装 SkillHub 和 memory-notes-1776123615 技能

方式二:设置 SkillHub 为优先技能安装源

设置 SkillHub 为我的优先技能安装源,然后帮我安装 memory-notes-1776123615 技能

通过命令行安装

skillhub install memory-notes-1776123615

下载

⬇ 下载 memory-notes v0.1.0(免费)

文件大小: 5.67 KB | 发布时间: 2026-4-15 13:23

v0.1.0 最新 2026-4-15 13:23
memory-notes v0.1.0

- Initial release documenting how to write structured notes for Basic Memory.
- Covers required note anatomy: frontmatter, body/context, observations, and relations.
- Explains observation syntax, semantic categories, and tagging for better knowledge graph structure.
- Details types of relations, wiki-links, and best practices for linking notes.
- Describes use of memory:// URLs for navigating and building context in the knowledge graph.

Archiver·手机版·闲社网·闲社论坛·羊毛社区· 多链控股集团有限公司 · 苏ICP备2025199260号-1

Powered by Discuz! X5.0   © 2024-2025 闲社网·线报更新论坛·羊毛分享社区·http://xianshe.com

p2p_official_large
返回顶部