关于 site-reliability-engineer
用于维护 Claude Skills 展示网站构建健康和部署安全的站点可靠性技能。它帮助贡献者检查 Markdown 与 MDX 问题、验证必需资源和组件属性,并诊断 Docusaurus 构建失败。
主要功能
- 01提交前验证 Markdown 和 MDX
- 02检查 Liquid 语法和尖括号
- 03验证 SkillHeader 属性
- 04检查必需图片和 ZIP 文件
- 05构建与缓存故障排查
适用场景
- 01提交前检查文档
- 02在 Docusaurus 构建前发现 MDX 问题
- 03诊断资源缺失或组件属性错误
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ curiositech/ some_claude_skills --skill site-reliability-engineer安装后在 Claude Code 中输入/site-reliability-engineer确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
CHANGELOG.md.claude-plugin/plugin.jsonreferences/ci-cd-integration.mdvalidation-logic.mdscripts/validate-brackets.jsvalidate-liquid.jsvalidate-skill-props.js详细介绍
站点可靠性工程师
专注于 Claude Skills 展示网站的 Docusaurus 构建健康状况、MDX 验证和部署安全。通过提交前验证和自动化健康检查,预防常见构建故障。
适用场景
适用于:
- Markdown/MDX 文件的提交前验证
- 捕获 Liquid 模板语法错误
- 验证 SkillHeader 组件属性
- 检查是否缺少主图/ZIP 文件
- 构建前链接验证
- 构建后健康报告
- 诊断 Docusaurus 构建失败
不适用于:
- 通用 DevOps(使用 deployment-engineer)
- Kubernetes/云基础设施(使用 kubernetes-architect)
- 运行时监控/告警(使用 observability-engineer)
- 数据库迁移(使用 database-migrations agents)
- 安全扫描(使用 security-auditor)
核心问题领域
5 个反复出现的反模式
| # | 问题 | 症状 | 修复方法 |
|---|---|---|---|
| 1 | 示例中包含 Liquid 语法 | Liquid 模板会破坏 MDX | 使用反引号表达式包裹 |
| 2 | 未转义的尖括号 | <70 被解析为 HTML | 使用 <70 |
| 3 | SkillHeader 属性错误 | SSG 构建失败 | 使用 fileName,而不是 skillId |
| 4 | 缺少关键文件 | 网站上看不到 Skill | 添加到 skills.ts |
| 5 | 缓存损坏 | 幽灵错误 | 清除 .docusaurus、build |
快速入门
安装钩子(一次性操作)
npm run install-hooks
手动验证
npm run validate:liquid # Liquid syntax
npm run validate:brackets # Angle brackets
npm run validate:props # SkillHeader props
npm run validate:all # All checks
清除缓存(遇到问题时)
rm -rf .docusaurus build node_modules/.cache
npm run build
提交前验证
提交前钩子会自动执行:
- Liquid 语法 - 扫描代码块之外的双花括号模板
- 尖括号 - 查找
<digit模式 - SkillHeader 属性 - 验证组件用法
- 必需文件 - 检查主图、ZIP 文件是否存在
速度:典型提交用时不到 5 秒
专家与新手的做法对比
| 新手 | 专家 |
|---|---|
| 运行完整构建进行检查 | 提交前检查可在 5 秒内捕获 90% 的问题 |
| 手动清除缓存 | 自动检测缓存问题 |
| 忽略警告 | 对失效链接零容忍 |
| 简单的正则表达式验证 | 考虑上下文(跳过代码块) |
反模式
反模式:使用完整构建进行验证
表现:运行 npm run build 检查错误
问题:耗时数分钟,而不是数秒;反馈缓慢
替代方案:运行 npm run validate:all(不到 30 秒)
反模式:忽略构建警告
表现:“构建成功,直接发布!”(忽略警告) 问题:失效链接会导致用户体验不佳,并累积技术债务 替代方案:构建后验证会在出现警告时失败
反模式:简单的正则表达式验证
表现:/\{\{.*?\}\}/(也会匹配代码块中的内容)
问题:代码示例中会产生误报
替代方案:跟踪代码块状态,跳过受保护区域
脚本(位于 scripts/ 文件夹中)
| 脚本 | 用途 |
|---|---|
validate-liquid.js | 检测未转义的 Liquid 语法 |
validate-brackets.js | 检测未转义的尖括号 |
validate-skill-props.js | 验证 SkillHeader 组件 |
故障排查速查表
| 问题 | 诊断 | 修复方法 |
|---|---|---|
| 钩子未运行 | ls -la .git/hooks/pre-commit | 运行 chmod +x 或重新安装 |
| 误报 | 模式位于代码块中 | 检查 ``` 标记 |
| 验证速度慢 | time npm run validate:all | 优化 glob 模式 |
成功指标
安装钩子后:
- 构建失败率:15% → 不到 2%
- 错误诊断时间:10 分钟 → 不到 1 分钟
- 验证速度:不到 30 秒
参考文件
references/validation-logic.md- 考虑上下文的检测模式references/ci-cd-integration.md- GitHub Actions、健康报告scripts/- 可用的验证脚本
可预防:Liquid 错误 | 尖括号故障 | 属性不匹配 | 缺少资源 | 失效链接
配合使用:skill-documentarian(同步)| docusaurus-expert(高级配置)
评论
支持 Markdown