원클릭으로
tutorial-quality-checker
审核与修复教程文章质量。用于检查 docs/tutorials 下章节是否符合固定模板与黄金标准,特别适用于“优化不是重构”场景、命令块渲染错误、文件创建命令缺失、章节结构缺口、代码路径与主线漂移等问题。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
메뉴
审核与修复教程文章质量。用于检查 docs/tutorials 下章节是否符合固定模板与黄金标准,特别适用于“优化不是重构”场景、命令块渲染错误、文件创建命令缺失、章节结构缺口、代码路径与主线漂移等问题。
Codex 또는 Claude로 설치 이 Prompt를 복사해 Codex, Claude 또는 다른 어시스턴트에 붙여 넣으면 Skill 페이지를 검토하고 설치를 진행할 수 있습니다.
SOC 직업 분류 기준
Write or heavily rewrite publish-grade technical tutorials, architecture chapters, and code-explainer articles from scratch. Use when Codex needs to produce high-quality long-form technical writing that must stay aligned with real code, include runnable commands/tests/examples, explain architecture and tradeoffs clearly, and satisfy repository writing standards such as docs/tutorials chapters, project guides, or engineering deep dives.
出版级技术文章深度审核与优化技能。用于审核并优化 docs/tutorials 及用户自定义 Markdown 技术文章:重排版提升可读性、加强每段主要代码的深度讲解(主流程拆解+成功/失败案例+图示+工程取舍),并严格保证不删减任何原有代码块。适用于“文章质量升级、结构重排、讲解加深、保持代码不丢失”的场景。
| name | tutorial-quality-checker |
| description | 审核与修复教程文章质量。用于检查 docs/tutorials 下章节是否符合固定模板与黄金标准,特别适用于“优化不是重构”场景、命令块渲染错误、文件创建命令缺失、章节结构缺口、代码路径与主线漂移等问题。 |
执行以下流程审查教程文章,并输出可执行修复建议或直接修复。
优先读取:
docs/tutorials/_CHAPTER_TEMPLATE.mddocs/tutorials/_TUTORIAL_GOLD_STANDARD.mddocs/tutorials/03-*.md)检查章节是否包含以下关键段落(允许顺序有轻微调整,但必须齐全):
目标架构位置说明(演进视角)前置条件本章主线改动范围(强制声明)实施步骤运行命令增量闭环验证验证清单常见问题本章 DoD下一章预告缺失时:只增量补齐,不重写整章。
重点检查:
path”前是否有创建命令。bash 和 powershell 代码块。 ```bash 后直接 ` ````)。将教程中的代码片段与主线真实文件比对,优先检查:
__init__.py)是否漏写子包导出。发现漂移时:优先修教程,不随意改主线代码。
其中“代码漂移”是重点检查项,默认必须执行。
运行:
uv run python skills/tutorial-quality-checker/scripts/check_tutorial_markers.py --file <章节文件路径>
uv run python skills/tutorial-quality-checker/scripts/check_tutorial_markers.py --file <章节文件路径>
说明:
文件:[...](path) 后的代码块需与真实文件一致。每次交付使用固定结构: