writing-notes SKILL.md skillA

writing-notes from ylxmf2005/longrein is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add ylxmf2005/longrein/writing-notes@git:20260923.8eb4b09

Pins git:20260923.8eb4b09 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
ylxmf2005/longrein
Path
skills/writing-notes/SKILL.md
Versions recorded
1
Latest version
git:20260923.8eb4b09, committed Sep 23, 2026
Size
3,031 bytes
Repository stars
11
License
none declared

做出以后有人会问"为什么这样改"的技术决定时使用:选型、比较多个方案、架构调整、删减功能、复盘不显然的缺陷,或用户说"就用 X""为什么不用 Y"时;修改已有 Note 记录的模块时也使用。在 `.agents/notes/` 中新建、更新或取代决策记录。提交信息、changelog 和普通文档不用它。.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# writing-notes

Note 是一份活的 ADR(Architecture Decision Record):记下为什么这样做、放弃了什么、代价是什么,给下一个改这段代码的人(包括 Agent)先读。代码和提交记录说明做了什么,Note 负责它们说不清的理由和取舍。

## 什么时候写

问一句:以后还有人会问"为什么这样改"吗?会就写。选型、取舍、踩过的坑、很诱人但被否掉的方案都算;还没写代码的方案也可以先写成 proposed。只改格式、无歧义的重命名、不改行为的依赖升级不用写。

仓库已经有自己的决策记录(如 `docs/adr/`)时,写在那里并沿用它的格式。

## 先更新,再新建

动手前用模块名和机制名搜 `.agents/notes/`,找到记录这个模块的 Note。多数时候应该更新它:把路径、类名、默认值改成现在的样子,让它始终描述当前代码,而不是在末尾追加"某日更新":读 Note 的人会把它当作现状。

新决定完全取代旧决定时,把旧 Note 里仍然有效的约束(安全边界、承诺不做的事、踩过的坑)搬进新 Note,再删掉旧 Note,或把它的状态改为 superseded 并链接到新 Note。同一件事只能有一篇 Note 给出当前说法。

被否掉的方案写进采纳方案的 Alternatives considered 就够了;只有它足够诱人、别人很可能再提时,才单独保留一篇 rejected。

## 写什么

文件放在 `.agents/notes/<首次写下的日期>-<主题>.md`:

```markdown
# <决定本身,如:会话存储用 SQLite,不用 JSONL>

Status: proposed | implemented | superseded by <链接> | rejected — <原因>

## Problem
什么问题、什么约束迫使要做决定;不看方案也能读懂。

## Decision
proposed 时写拟采用的方案和怎样算完成;implemented 时用现在时写已经落地的事实。

## Alternatives considered
每个真正考虑过的方案一段:先写它最有力的理由,再写为什么没选。包含"不做"或"复用已有能力"这一档。

## Consequences
收益和代价都写。简化类决定写明它的上限,以及出现什么信号时应该重新考虑。
```

说"更快""更稳"时给出对比基线,没有基线就只陈述事实。

## 让代码指回 Note

决定落地后,在受它约束的核心入口(公开接口、模块入口或状态机)留一行注释:

```ts
// Note: 会话存储为什么用 SQLite,见 .agents/notes/2026-08-23-session-store-sqlite.md
```
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add ylxmf2005/longrein/writing-notes@sha256:330af07756424f60

The line at the top of this page pins the label git:20260923.8eb4b09, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_btthg2g53o23jnmv.svg)](https://markdownregistry.com/a/art_btthg2g53o23jnmv)

4 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Sep 23, 2026.

versioncommittedcommitsizeaudit
git:20260923.8eb4b09 latest2026-09-23 8eb4b09 3,031 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (3031 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

ylxmf2005/longrein · 11 stars · license none declared · pushed 2026-10-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_btthg2g53o23jnmv
GET https://markdownregistry.com/api/v1/resolve?ref=ylxmf2005/longrein/writing-notes
GET https://markdownregistry.com/api/v1/blob/330af07756424f6054060916722509ad912e3ec09ef9a361783ac23d0c7c2678

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from ylxmf2005/longrein

AGENTS.md AGENTS.md file
ylxmf2005/longrein · AGENTS.md
git:20260928.ff7811d · audit A · 11 stars
frontend-design SKILL.md skill
ylxmf2005/longrein · skills/frontend-design/SKILL.md · 新建、重设计或明显打磨网站、落地页、Web App、dashboard、编辑器、表单或前端组件时使用,包括"把这个页面做好看点""重做一下这个界面""做个落地页"这类说法。先定一个明确的视觉方向,再实现可运行的界面,并在真实浏览器里检查桌面…
git:20261001.490039e · audit A · 11 stars
review SKILL.md skill
ylxmf2005/longrein · skills/review/SKILL.md · 用户要求 review、CR,让你看看某个改动、PR、MR、设计或方案有没有问题,或者要判断它能不能合并、交付时使用。独立冷读准确的对象,查完影响范围,每个问题先试着推翻再报告,最后给出结论。只想弄懂改了什么时用…
git:20260923.8eb4b09 · audit A · 11 stars
shape SKILL.md skill
ylxmf2005/longrein · skills/shape/SKILL.md · 用户要求 Shape、输入 /shape,或想先对齐方案、由自己做关键决定再动手时使用。先调查现实,摆出选项和代价,逐轮只问现在能决定的问题,用户做出关键决定后再进入实现。用户没有提出时不用,即使目标还不确定,也只建议用户用 Shape。
git:20260923.8eb4b09 · audit A · 11 stars
test SKILL.md skill
ylxmf2005/longrein · skills/test/SKILL.md · 用户要求测试、E2E、回归、复现缺陷,或要判断一个功能、修复、迁移能不能交付时使用。先写测试计划,再从真实入口走到结果真正生效的地方执行,最后按计划逐项报告。写代码过程中跑一下单测、编译这类顺手检查不用;判断代码写得好不好用 review。
git:20260923.8eb4b09 · audit A · 11 stars
walkthrough SKILL.md skill
ylxmf2005/longrein · skills/walkthrough/SKILL.md · 用户想弄懂一段代码、diff、分支、MR、设计或一次故障,以便核对、接手或做决定时使用,例如"讲讲这个改动""带我过一遍这个模块""这个 PR 做了什么"。只问一个概念、一句话能答清时直接回答;要判断能不能合并时用 review。
git:20260923.8eb4b09 · audit A · 11 stars
writing-prompts SKILL.md skill
ylxmf2005/longrein · skills/writing-prompts/SKILL.md · 写、改写或审查 Prompt、AGENTS.md、Skill 与子代理任务说明时使用。从上下文怎样影响模型生成出发,判断每句话在引导什么、连带什么、稀释什么,重点改内容,排版只在影响理解时才动。
git:20260923.8eb4b09 · audit A · 11 stars

Every file in ylxmf2005/longrein

Browse by kind, by grade A, or by owner.