学习记录格式Learning Record Format实战指南为 PentestGPT 教学工作区建立可持续的最近发展区信号源【免费下载链接】PentestGPTAutomated Penetration Testing Agentic Framework Powered by Large Language Models项目地址: https://gitcode.com/GitHub_Trending/pe/PentestGPT导读本文讲解 PentestGPT 仓库中teach技能所依赖的学习记录Learning Record文件格式它存放在工作区的./learning-records/目录下以0001-slug.md式的顺序编号命名是教学会话中捕捉非显而易见教训、关键洞察与已声明先验知识的最小化文档单元。读完本文你将掌握该格式的完整模板、可选元信息、编号与取代规则以及什么时候该写、什么时候不该写的判定标准并理解它如何与教学工作区中的 MISSION.md、GLOSSARY.md 协同共同支撑最近发展区Zone of Proximal Development的计算。一、学习记录是什么教学侧的 ADR在 teach 技能定义 中教学工作区Teaching Workspace由一组文件构成MISSION.md学习动机、RESOURCES.md高质量资源清单、./lessons/*.html单次课程成品、./reference/*.html可打印参考文档、NOTES.md偏好备忘以及本文主角./learning-records/*.md。学习记录被明确定义为软件架构决策记录ADR在教学场景的等价物ADR 记录一次决策被做出、以及为什么学习记录记录用户已经学会了什么、以及为什么它影响接下来该教什么。ADR 的价值在于记录做了决定与决定的原因而非填满章节学习记录同样如此——它的价值在于记录这个知识点现在已知了和它如何改变后续教学内容而不是凑齐模板字段。两者都采用顺序编号的文件命名且目录都采用懒创建策略只有当第一份记录真正需要写出时才创建目录避免为空的约定目录。这一类比在仓库的 domain-modeling 技能 中可以看到完整对照ADR 同样是一段即可成文的极简格式同样有可选元信息Status/Considered Options/Consequences同样通过扫描目录中最大编号来递增。学习记录几乎就是这套思想的教学化移植。二、完整模板一段即可不设强制章节学习记录的完整格式如下# {对学到了什么或确立了什么的简短标题} {1-3 句话学到了什么或确立了哪些先验知识以及它为什么对未来的会话重要。}这就是全部格式。一份学习记录可以只有一个段落。规范明确强调价值来自记录下来那件事现在已知了以及它为什么会改变接下来教什么而绝不来自填满各个章节。这是与日志、周报类文档的根本区别——记录是决策级洞察decision-grade insights不是流水账。从源码结构看该规范与 MISSION-FORMAT.md动机文档同样要求1-3 句话式精炼以及 GLOSSARY-FORMAT.md术语定义同样要求一两句话保持了完全一致的极简哲学文档越短越可能被反复阅读、越可能真正指导行为。三、可选章节按需添加默认不加以下三个可选部分仅在它们带来真实增量价值时才应出现且大多数记录都不需要它们可选章节作用适用时机Statusfrontmatteractive \| superseded by LR-NNNN当某个较早的理解被证明有误、并被新记录取代时Evidence用户如何证明了这一理解答对的问题、完成的练习、引用过的先验经验当该论断日后可能被重新审视时Implications这一理解对未来会话解锁了什么、或排除了什么当影响非显而易见、值得专门记录时以Status为例它采用 frontmatter 形式承载元数据与 ADR-FORMAT.md 中proposed \| accepted \| deprecated \| superseded by ADR-NNNN的状态机设计同构目的都是让记录本身可以被机器与人类一致地解析和追踪。四、编号规则扫描最大值 1命名规范为0001-slug.md、0002-slug.md……slug 使用 dash-case连字符小写命名。具体操作步骤扫描./learning-records/目录找出当前存在的最大编号在其基础上递增 1作为新记录的文件名。目录采用懒创建仅在写出第一份记录时才创建./learning-records/。编号的稳定性是后续取代supersession机制得以成立的前提——superseded by LR-NNNN必须能唯一指涉到某一编号的记录。五、何时应该写学习记录四个硬性触发条件满足以下任一条件就应写入一份学习记录用户展示了非平凡理解的真实证据——不只是接触过而是有证据表明能正确使用该概念。这会为接下来教什么设置一个新的下限floor。用户披露了先验知识——例如我已经知道 X。记录它让未来会话不再重复教学同时还要记录其声称的深度depth。一个误解被纠正——用户此前相信了错误的东西现在明白了原因。这类记录价值最高它们能预测相关主题上未来的绊脚石。学习引发使命偏移——用户发现自己真正在乎的与原先设想的不同。此时应交叉链接 MISSION.md 并同步更新它在 SKILL.md 的Mission一节同样明确使命变化是正常的更新MISSION.md并新增一条学习记录来捕获这一变化且必须先与用户确认再改动使命。什么不算数不写仅被覆盖过的材料。覆盖不等于学习。要等待证据出现。任何已在 GLOSSARY.md 中以术语定义形式简洁捕获的内容——不重复记录。逐会话的活动日志。学习记录不是日记journal它们是决策级洞察。这三条否定规则与正面规则同样重要它们共同保证目录中只沉淀改变教学决策的信息而非噪音。六、取代机制理解演化的历史本身就是信号当一条较晚的记录与较早的一条矛盾时用户的理解加深或被纠正规范要求在旧记录中标注Status: superseded by LR-NNNN而不是删除它保留的原因是理解如何演化这一历史本身是有用的信号——它记录了用户踩过的坑、纠偏的过程以及未来同类主题上可能再次出现的认知障碍。这一设计与仓库中 ADR 的取代约定superseded by ADR-NNNN保持一致也与 GLOSSARY-FORMAT.md 的随理解加深就地修订、不留过时条目形成互补术语定义就地更新而学习记录追加新编号并标记旧编号。前者压缩语言后者保留轨迹。七、学习记录如何驱动教学闭环在 teach 技能 的运行时逻辑中学习记录不是被动存档而是主动输入计算最近发展区ZPD每次授课前教师 Agent 通过阅读learning-records判断用户当前的能力下限再结合MISSION.md确定最相关且恰好落在 ZPD 内的下一课——挑战恰到好处just enough既不过难浪费工作记忆也不过度重复已确认掌握的内容。区分流畅强度与存储强度学习记录对应的是长期存储强度storage strength而非即时检索的流畅强度fluency strength。只有被记录下来的、有证据的理解才能被当作后续教学的起点。驱动使命再校准当学习引发使命偏移触发条件 4学习记录与MISSION.md的交叉链接确保为什么学与学到了什么始终保持同步演进。这意味着记录不是教学的副产品而是教学决策的输入数据。对于任何使用teach技能进行多会话教学的场景无论是安全知识、编程还是其他技能主题维护好这份极简格式的学习记录就是维护一套可靠的、可审计的学习状态机。八、速查清单维度规则存放位置工作区./learning-records/懒创建命名0001-slug.md顺序编号slug 为 dash-case编号获取扫描目录最大编号 1正文一个 H1 标题 1-3 句话说明可选元信息Status/Evidence/Implications默认不加何时写有理解证据、披露先验、纠正误解、使命偏移何时不写仅覆盖过、术语已在 GLOSSARY、活动日志取代旧记录标superseded by LR-NNNN不删除最小可用范式与 ADR、MISSION、GLOSSARY 共用极简段落哲学关键源文件LEARNING-RECORD-FORMAT.md本格式规范、SKILL.md教学工作区总览与 ZPD 机制、MISSION-FORMAT.md使命文档格式、GLOSSARY-FORMAT.md术语表格式、RESOURCES-FORMAT.md资源清单格式、ADR-FORMAT.md同构的决策记录格式。【免费下载链接】PentestGPTAutomated Penetration Testing Agentic Framework Powered by Large Language Models项目地址: https://gitcode.com/GitHub_Trending/pe/PentestGPT创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考