SuperAPI AI 工具集

obsidian-md-standard

通用与其它

查看项目

更新于 10-16 06:42

技能介绍

用途:为所有会生成 Markdown 文档的 SynapSync 技能定义统一规范,确保每个 .md 输出都是 Obsidian 原生格式,包含丰富的 YAML frontmatter、wiki 链接、双向引用、活文档模式、可追踪 ID 和指标表格。当多个技能为同一项目产出文档时,结果是 Obsidian 中互联的知识图谱,而非孤立文件集合。

主要能力:1)通用 frontmatter 模式,必填字段包括 title、date、updated、project、type、status、version、tags、changelog、related,并按文档类型扩展 sprint、phase、progress、previous_doc、next_doc、parent_doc、vision_ref、retro_refs、metrics、approved_by、approved_date、severity、scope_modules 等字段。2)文档类型分类法,涵盖 analysis、conventions、requirements、architecture、plan、execution-plan、sprint-plan、progress、technical-report、refactor-plan、retrospective、decision-log、data-model、flow-diagram。3)wiki 链接约定:文档间引用必须用 [[filename]],Markdown 链接仅用于外部 URL;支持 [[filename#Section]]、版本标注、别名引用。4)每篇文档以 ## Referencias 结尾,列出 Parent、Siblings、Children、Input Documents、External。5)活文档模式:通过 version 与 changelog 追踪,状态在 draft→active→completed→superseded→archived 间流转,修改时需升版本、更新日期、追加 changelog。6)ID 系统:FR-、NFR-、ADR-/DEC-、T-、K-、P-、L-、A-、D-、M- 等前缀,ID 在文档内作用域,顺序编号且不复用。7)双向引用:A 引用 B 时 B 必须反向引用 A。8)指标表格统一为 | Metric | Before | After | Delta | Status |,状态值含 NOT_STARTED、IN_PROGRESS、IMPROVED、DEGRADED、COMPLETED、AT_RISK。9)毕业门:用 - [ ] / - [x] 复选框,标准须可验证,未达标不得转为 completed。10)顺序编号:同目录有阅读顺序时用 01-、02- 两位补零前缀。11)延续规则:Sprint 2 及之后文档包含 ## Carried Forward from [[previous-sprint]],列出未完成项与继承决策。12)回顾模板,含 Context、Keep、Problems、Learnings、Actions、Metrics、Signals to Watch、Verdict、Referencias。

使用方式:该技能是规范,用户不直接调用;其他技能引用它,并把相关精简配置嵌入自身的输出指令中。技能作者在创建或更新会写入 {output_base} 的 .md 文件的技能时使用;也可用于校验生成文档是否符合 Obsidian 原生标准。规范提供 Planning、Technical Report、SDLC 等领域配置,各技能在 ## Obsidian Output Standard 章节嵌入对应子集。

适用场景:SynapSync 技能生成项目规划、需求、架构、冲刺计划、进度看板、技术报告、重构计划、回顾等 Markdown 文档时。

限制:不供用户直接调用;具体命令、安装方式、收费与平台信息暂未提供。