SuperAPI AI 工具集

cheat-sheets

部署与运维

查看项目

更新于 10-16 05:46

技能介绍

用途:为 DevOps LMS 创建可快速查阅的速查表(cheat sheet),而非课程总结。速查表面向工作时的快速查找、学习后的记忆强化,以及打印张贴在桌面的参考。

主要能力:提供文件位置与命名规范(路径 content/{phase}/{topic}/99.cheat-sheet.md,URL 形如 /phase-1-sdlc/sdlc-models/cheat-sheet,99. 前缀确保排在导航最后);规定必需的 Frontmatter 字段,包括 isCheatSheet: true(触发速查表布局与 PDF 导出)和 cheatSheetTopic(用于 PDF 元数据的人类可读主题名)。提供三类内容模板:概念对比(术语表、快速对比表、决策指南)、命令参考(命令表、常见模式、故障排查)、流程参考(流程概览、分步速查、最佳实践清单)。

使用方式:按模板组织内容,用表格做对比、用列表列要点、用代码块放命令;每个速查表必须包含 Interview Quick Hits 章节(4-8 组问答,放在 Common Pitfalls 或 Troubleshooting 之前)。禁止使用插图类 MDC 组件(如 IllustrationLinearFlow、IllustrationChecklist、IllustrationPyramid),保持纯文本与表格以利于 PDF 导出。

适用场景:方法论、工具命令、工作流等主题的快速参考页。

限制:速查表不含测验;内容长度建议 1-3 页打印页;表格需简洁以免跨页断裂;需测试 PDF 导出可读性。组件方面涉及 CheatSheetLayout.vue、CheatSheetPdfButton.vue 与 useCheatSheetPdf.ts(downloadCheatSheet(title, slug)、isGenerating、error)。