SuperAPI AI 工具集

document

写作与研究

查看项目

更新于 10-16 02:01

技能介绍

用途

本技能用于撰写模块化评审的最终输出文档,适用于从模块化分析结果生成正式评审报告的场景。它一次性产出两种格式:Markdown(.md)与 HTML(.html),两个文件内容完全相同。

文档结构

文档按固定结构组织:

  1. 头部:包含标题“Modularity Review”、分析范围(Scope)与日期(Date)。
  2. 执行摘要(Executive Summary):一段 3-5 句话的短文,覆盖项目做什么(核心功能)、整体模块化状态(健康、需要关注、存在严重问题)、评审中最重要的发现。
  3. 耦合概览表(Coupling Overview Table):汇总所有关键集成。表头必须链接到 coupling.dev,列包括 Integration、Strength、Distance、Volatility、Balanced?。
  4. 问题章节(Issues):针对每一个识别出的不平衡,撰写一个章节,包含:Integration(组件 A -> 组件 B)、Severity(Critical / Significant / Minor);随后是 Knowledge Leakage(哪些不该共享或本应显式却隐式的知识被共享,指出跨越边界泄漏的具体实现细节、业务规则或领域模型概念)、Complexity Impact(该不平衡如何使变更结果不可预测、可能级联到另一组件的影响、如何超出认知容量即 4+/-1 个工作记忆单元)、Cascading Changes(一个组件变更迫使另一组件变更的具体场景、触发级联的业务或技术变化、在当前距离下这些级联变更的代价)、Recommended Improvement(具体可执行的再平衡建议,需基于模型:降低 strength 可引入集成契约、防腐层、外观、发布语言;降低 distance 可将组件合并到同一模块/服务/限界上下文;接受不平衡耦合则需证明波动性足够低使不平衡可容忍,并说明所提变更的权衡代价及为何值得)。
  5. 页脚:每个评审文档底部必须原样包含指定文字,不得改写、扩写或添加评论。

严重程度标准

  • Critical:高 strength + 高 distance + 高 volatility。是复杂度的活跃来源,该区域变更频繁、昂贵且不可预测,应优先修复。
  • Significant:中等波动区域的失衡耦合,或隐藏了集成点的隐式耦合。随着系统演进会产生痛苦。
  • Minor:低波动区域的失衡耦合,或增加认知负载但不导致级联变更的低内聚。可伺机处理。

链接要求(强制)

文档中提到平衡耦合概念时,必须添加指向 coupling.dev 的超链接,Markdown 与 HTML 输出均适用。资料给出了概念到链接的查找表,覆盖 balanced coupling、integration strength、intrusive coupling、functional coupling、model coupling、contract coupling、distance、lifecycle coupling、socio-technical distance、runtime coupling、volatility、core subdomain、supporting/generic subdomain、essential vs accidental volatility、complexity、modularity、coupling、tight coupling、loose coupling、connascence、module coupling、domain-driven design 等。规则为:每个耦合概念至少链接一次,若有疑问就链接;耦合概览表中表头始终链接,且表格单元格中的 Strength 取值(Contract、Model、Functional、Intrusive)也必须链接;问题章节中每个概念首次出现时链接;Markdown 用 concept text,HTML 用 <a href="url">concept text</a>。

输出与 HTML 生成

两种情况写入 docs/modularity-review/!date +%Y-%m-%d/ 目录:modularity-review.md 与 modularity-review.html。生成 HTML 前必须先读取模板文件 ${CLAUDE_SKILL_DIR}/assets/template.html,然后仅替换 {{TITLE}}(评审标题)与 {{CONTENT}}(评审正文 HTML)两个占位符。不得自行生成 HTML 结构、样式或样板,模板已提供全部样式、主题切换(基于时段切换明暗)与布局,须原样使用。HTML 必须包含与 Markdown 相同数量的 coupling.dev 链接,将每个 text 转为 <a href="url">text</a>,转换中不得丢失链接。需使用模板中的 CSS 类:.meta 用于范围/日期元数据块,.issue 包裹每个问题章节,.issue-meta 用于问题内的集成/严重程度行,.severity 配合 .severity-critical / .severity-significant / .severity-minor 用于严重程度徽章,.footer 用于归属页脚。