SuperAPI AI 工具集

arc42-lint

编程与开发

查看项目

更新于 10-23 16:17

技能介绍

用途:arc42-lint 用于检查遵循 arc42 工具包约定的架构文档中,跨章节的标识符是否保持一致。它只做工具包约定层面的一致性校验,不评价内容质量,也不检查文档是否完整。

主要能力:该技能包含五条一致性规则。第一条检查第3章定义的 IF-xx 接口 ID 是否出现在第5章一级构件中,并做反向检查。第二条检查第5章的构件名称是否出现在第7章部署映射中。第三条检查第10章质量场景使用的 Q42 标签是否在第1.2章质量目标中出现。第四条检查第9章各 ADR 的 Risks created 行中提到的 RISK-xx 是否在第11章风险矩阵中有对应条目。第五条检查第10.3章中当前状态为未测量的 QS-xx 愿景场景是否在第11章中被引用。

使用方式:先确认文档目录和文档语言(默认英语,内置可选 de、fr、it、es、pt),并检查项目中是否存在 scripts/arc42-lint.py。如果存在,优先运行该脚本:python scripts/arc42-lint.py <docs_path> --lang <lang> --format text;需要严格模式时加上 --strict。如果没有脚本,则按规则人工核对相关章节,非英语文档可参考 scripts/languages/<lang>.json 中的对应词句。完成检查后,按规则结果表、错误与警告清单、最终结论的格式输出报告,并可以协助修复问题后重新复检。

适用场景:适合使用 arc42 工具包 ID 约定编写架构文档的团队,在提交或评审前检查接口、构件、质量标签、风险与愿景场景之间的交叉引用是否一致。

限制:这些规则属于工具包约定,并非官方 arc42 要求;不评估内容质量与完整性;缺少脚本时只能人工核对;脚本的安装方式、运行环境依赖和语言支持细节暂未提供。