PentestGPT 教学工作区 GLOSSARY.md 格式规范为 Agent 驱动的学习环境设计术语表【免费下载链接】PentestGPTAutomated Penetration Testing Agentic Framework Powered by Large Language Models项目地址: https://gitcode.com/GitHub_Trending/pe/PentestGPTGLOSSARY.md 格式规范.agents/skills/teach/GLOSSARY-FORMAT.md定义了教学工作区中术语表的唯一权威格式。在 PentestGPT 这类由 LLM 驱动的项目中Agent 需要为学习者持续生成解释、练习与学习记录而一份统一的术语表能确保所有教学产物共享同一套术语语言。读完本文你将掌握术语表的结构模板、七条撰写规则、以及如何将它与 MISSION.md、learning-records、lessons 等教学工作区文件协同运作从而为任何技术主题构建可复用的术语表。一、术语表在教学工作区中的定位教学技能.agents/skills/teach/SKILL.md将当前目录视为一个教学工作区Teaching Workspace学习者的全部学习状态由若干文件承载MISSION.md记录学习者对主题感兴趣的原因格式见 MISSION-FORMAT.md./reference/*.html参考文档目录术语表即属于此类压缩型参考材料RESOURCES.md可信资源清单格式见 RESOURCES-FORMAT.md./learning-records/*.md学习记录等价于软件开发中的架构决策记录ADR格式见 LEARNING-RECORD-FORMAT.md./lessons/*.html一课一文件的独立课程单元NOTES.md偏好与工作笔记草稿。GLOSSARY.md是这份工作区的规范语言canonical language。所有解释explainers、练习exercises与学习记录learning records都必须遵循其术语体系。术语表的构建本身就是学习过程的一部分——将一个概念压缩成一段精炼定义本身就是学习者已经理解该概念的证据。从源码结构看这一设计理念与writing-great-skills技能中的词汇表实践一脉相承后者将技能的完整定义下沉progressive disclosure到同级GLOSSARY.md文件中令 SKILL.md 顶层保持可读而教学工作区则让术语表成为整个学习过程的语言锚点。二、术语表的结构模板GLOSSARY-FORMAT.md 给出了完整的 Markdown 结构# {Topic} Glossary {One or two sentence description of the topic this glossary covers.} ## Terms **Hypertrophy**: Muscle growth driven by mechanical tension and metabolic stress over repeated training sessions. _Avoid_: Bulking, getting big **Progressive overload**: Systematically increasing the demand on a muscle over time — via load, volume, or intensity. _Avoid_: Pushing harder, levelling up **RPE (Rate of Perceived Exertion)**: A 1–10 self-rating of how hard a set felt, where 10 is failure and 8 means two reps left in the tank. _Avoid_: Effort score, intensity rating模板由三个部分组成H1 标题# {Topic} Glossary其中{Topic}为术语表覆盖的主题主题概述一到两句说明该术语表覆盖的主题范围## Terms小节逐条列出术语。每条术语使用粗体术语名 冒号开头随后是精炼定义最后用_Avoid_:列出应避免的同义别名。仓库中已有一份完整的参考实现即writing-great-skills。它以# Glossary — Building Great Skills为标题开篇一句话点明领域模型——技能存在的意义是从随机系统中提炼确定性其根本美德是Predictability——并说明该术语表是writing-great-skills技能的公开参考disclosed reference。这正是模板中一到两句主题描述的实战范本。三、词条的解剖定义 Avoid别名模板中每条词条包含三个要素粗体术语名词条的唯一规范名如**Hypertrophy**、**Progressive overload**、**RPE (Rate of Perceived Exertion)**。术语名后紧跟冒号。精炼定义一到两句定义概念是什么what the term IS而非做什么或如何做。_Avoid_别名清单同一概念存在多个说法时选定最佳用词并将其他说法列为应避免的别名。例如_Avoid_: Bulking, getting big——这就是语言压缩language compression的落点。写作时要严格遵守定义用词一致术语表内部的定义必须优先使用术语表自身的术语。一旦某个术语进入术语表就应在所有场景包括其他定义内部优先使用它这使复杂术语在后续更容易被掌握。避免用词模糊如果一个术语在更广泛的领域中用法松散需显式标注解决方式例如In this workspace, set always means a working set — warm-ups are tracked separately.在本工作区中set 始终指工作训练组——热身组单独跟踪。从writing-great-skills/GLOSSARY.md可以看到这一约定的完整展开每个定义末尾带_Avoid_行如_Avoid_: consistency, reliability, robustness, output-determinism且定义内部大量使用粗体引用本表其他术语如 The root virtue every other term serves。这正是定义内部使用术语表自身术语的实践。四、七条撰写规则详解GLOSSARY-FORMAT.md 的 Rules 部分给出了七条硬性规则每条都直接影响术语表的可用性仅在用户真正理解时添加术语Add a term only when the user understands it术语表是压缩知识的记录而非供学习者阅读的词典。如果用户只是刚接触某个概念应等到他们能正确使用后再收录。这与LEARNING-RECORD-FORMAT.md的未达标清单遥相呼应——仅被覆盖的材料不算学习等待证据Coverage is not learning. Wait for evidence.。要有立场Be opinionated当同一概念存在多个词汇时选定最佳者并将其余列为应避免的别名。这是语言压缩的机制。例如 RPE 的别名_Avoid_: Effort score, intensity rating。保持定义精炼Keep definitions tight一到两句定义概念是什么而非做什么或如何做。定义内部使用术语表自身的术语Use the glossarys own terms inside definitions已在术语表中的术语应优先在一切地方使用——包括其他定义内部。这使复杂术语更易理解。自然聚类时使用子标题分组Group under subheadings当出现自然的主题簇时用子标题如## Anatomy、## Programming分组术语本身内聚时平铺列表即可。参考实现中writing-great-skills/GLOSSARY.md就按 Invocation、Information Hierarchy、Steering、Pruning 四个轴分组并用三级标题如### Model-Invoked组织词条。显式标记歧义Flag ambiguities explicitly如果某术语在更广领域中被松散使用注明本工作区的解决方式resolution。随理解深化而修订Revise as understanding deepens用户第一周写下的定义可能在第六周已被证明是错的。应就地更新不要遗留过时词条。五、术语表与教学工作区其他文件的协同与学习记录的分工LEARNING-RECORD-FORMAT.md明确规定了术语表与学习记录的分工边界学习记录的未达标清单中写明已精简收录于 [[GLOSSARY.md]] 作为词条定义的内容不要重复Anything already captured tersely in [[GLOSSARY.md]] as a term definition. Dont duplicate.。即术语表负责概念的压缩定义单点事实源学习记录负责非显而易见的经验与关键洞察以及用户理解深化或纠偏的证据。学习记录中的误解被纠正场景misconception was corrected尤其有价值因为它能预测相关主题未来的绊脚石——这类记录应当写入learning-records/而修正后的正确概念则应同步更新到术语表词条。与课程单元的关系SKILL.md指出词汇表Glossaries是任何自带术语体系主题的必备参考文档essential reference一旦创建就应在每节课中遵循它Once one is created, it should be adhered to in every lesson。术语表属于./reference/参考材料体系而课程./lessons/*.html应当通过 HTML 锚点链接到术语表等参考文档。与技能词汇表的关系术语表机制同样存在于技能skill体系中writing-great-skills/SKILL.md将完整定义下沉披露到同级GLOSSARY.md并约定粗体术语在 GLOSSARY.md 中定义可在其中查阅完整含义。这与教学工作区的术语表是同一语言压缩思想在不同场景的复用无论是技能写作还是教学过程都通过单一权威术语 精炼定义 避免别名来压缩语言的熵。六、实践为 PentestGPT 技术主题编写术语表将以上格式与规则落地到本仓库的实际技术主题时可参照writing-great-skills/GLOSSARY.md的编写手法。以下示例演示如何为一个类似的安全测试框架主题编写符合规范的术语表# {Reconnaissance} Glossary Terms for early-stage target discovery in automated penetration testing workflows. ## Terms **Active recon**: Direct interaction with a target system to elicit responses and map exposed services. _Avoid_: Probing, scanning around **Passive recon**: Gathering information from public and third-party sources without touching the target. _Avoid_: OSINT gathering, quiet recon编写时对照七条规则自查术语是否在用户理解后才收录定义是否一到两句、聚焦是什么是否选定了规范词并列出避免的别名定义内部是否复用了术语表已有术语是否显式标注了歧义如在本工作区中recon 仅指……是否随理解深化及时就地修订结语GLOSSARY.md 格式规范虽然篇幅简短却定义了一套完整的术语治理方法论结构化模板保证机器可解析_Avoid_别名机制实现语言压缩七条规则保证术语表始终是压缩知识的活记录而非死词典。它与教学技能体系中的 SKILL.md、MISSION-FORMAT.md、LEARNING-RECORD-FORMAT.md、RESOURCES-FORMAT.md 共同构成了一个自洽、可复用的 Agent 教学框架——而writing-great-skills/GLOSSARY.md则是一份可供直接参考的完整实现范例。【免费下载链接】PentestGPTAutomated Penetration Testing Agentic Framework Powered by Large Language Models项目地址: https://gitcode.com/GitHub_Trending/pe/PentestGPT创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考