关于 spec-loop-setup-doc-rendering
用于设置或修复任务文件与术语表渲染的 Agent 技能,面向 Spec Loop 项目。它要求先检查项目内配置和命令结果,再报告现状与无法验证之处,并按编辑器路径指导端到端渲染验证。
主要功能
- 01检查项目内编辑器配置
- 02按 VS Code 或 JetBrains 路径排查
- 03验证 PlantUML 与 Graphviz 设置
- 04判断是否需要 AsciiDoc 支持
- 05建议 Markdown 和 AsciiDoc 探测文件
- 06变更编辑器设置前征求确认
适用场景
- 01排查任务文件渲染故障
- 02验证术语表图表能否渲染
- 03根据项目配置检查编辑器设置
安装
复制下面的命令,在终端中运行。
npx skills add https:/ / github.com/ dpolivaev/ spec-loop --skill spec-loop-setup-doc-rendering安装后在 Claude Code 中输入/spec-loop-setup-doc-rendering确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
jetbrains-setup.mdvscode-setup.mdscripts/setup-vscode-server-based.sh详细介绍
用于设置或修复任务文件和术语表文件的渲染。
仅在此文件中保留仅适用于 Agent 的行为。将 vscode-setup.md 和 jetbrains-setup.md 视为共享设置参考,而不是编写 Agent 策略说明的地方。
不要只是复述设置参考。先自行通过命令和可访问的项目本地配置收集证据,然后 报告:
- 哪些功能已正常工作,
- 缺少什么或哪些功能已损坏,以及
- 哪些内容仍无法直接验证。
完成直接检查后,建议创建小型 Markdown 和 AsciiDoc 探测文件,以端到端验证渲染效果。这些探测文件应覆盖当前工作流预期使用的图表类型,并且必须至少包含一个类图。还应包含其他相关类型,例如时序图、组件图和 Mermaid 术语表图。
优先直接检查,而不是让用户执行例行检查。
遵循所选的设置路径:
- 使用 JetBrains 路径时,作为 PlantUML 验证的一部分,检查 Graphviz:运行
command -v dot和dot -V。 - 使用 VS Code 仅本地 PlantUML 路径时,检查 Java:运行
command -v java和java -version;检查 Graphviz:运行command -v dot和dot -V;并对任何已配置的本地plantuml.jar路径运行test -f。 - 使用 VS Code 服务端路径时,优先采用辅助脚本检查路径;除非故障排查表明应使用仅本地路径,否则不要检查 Java、Graphviz 或本地
plantuml.jar。
根据当前项目状态判断是否需要 AsciiDoc 支持,包括是否存在 glossary.adoc 或是否明确使用 Spec Loop AsciiDoc 术语表格式。
优先使用项目本地证据,例如存在时的 .idea/、.vscode/ 和工作区文件。
对于 VS Code、Cursor 和其他基于 VS Code 的 IDE,如果服务端设置路径、此技能目录和受支持的编辑器 CLI 均可用,优先采用辅助脚本检查路径。
除非用户明确批准检查仓库外部的编辑器状态,否则请留在项目目录内。如果无法通过项目本地文件验证插件或 IDE 设置,请先征求用户同意,再检查外部编辑器配置目录。
更改插件、扩展、IDE 设置或编辑器设置前,先征求用户确认。
如果用户显然是指修正明显的拼写错误或消除一个无关紧要的单词歧义,请直接明确确认。不要使用正式的澄清措辞。
对于 VS Code、Cursor 和其他基于 VS Code 的 IDE,请阅读 vscode-setup.md。 对于 JetBrains IDE,请阅读 jetbrains-setup.md。
仅使用此处实际存在的设置文档。