[curriculum-eval] 04-github-actions-intro.md: cognitive_load — 28 new concepts in a 5-minute intro, low activity density

未关闭 适合新手
#5,471 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 3 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
75/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
github-actions, markdown, yaml

调研方向

从 workshop/04-github-actions-intro.md 开始,检查该页面如何介绍 workflow 概念、实践活动和 checkpoint。将页面与指定的限制进行比较:概念不超过15个,活动密度至少为每100词3个;将高级概念移至指定的 side quest,并添加一项活动,同时保留指定的章节和文风。运行 issue 中的 markdownlint 命令,并确认 checkpoint 仍至少包含四项。

由索引模型根据 Issue 内容生成。

描述

curriculum documentation quality

File: workshop/04-github-actions-intro.md
Overall Score: 5.4 / 10.0 (corpus mean: 6.06)

Flagged Dimensions:

Dimension Score Benchmark Delta
cognitive_load 6.8 ≥ 9 (≤ 800 words, ≤ 15 concepts) −2.2 (28 new concepts vs 15)
active_learning 3.9 ≥ 10 (density ≥ 3) −6.1
checkpoint_quality 0.0 (detector bug, see the checkpoint-detector issue; real checkpoint has 4 items) ≥ 10 n/a

Root Cause (≤ 2 sentences):
The page introduces 28 new concepts in 756 words (triggers, jobs, runners, actions, steps, plus agentic comparisons), nearly double the 15-concept benchmark. Only 5 checklist items and few code blocks give an activity density of 1.9 per 100 words.

Evidence (quoted from the file):

A GitHub Actions workflow is a YAML file in .github/workflows/ that tells GitHub: when to run (on), what to run (jobs), how each job executes (steps)

Learning Science Rationale:
Sweller's Cognitive Load Theory predicts that novices can hold only a few new elements in working memory; introducing 28 terms in one "5 minute" page before any hands-on practice raises intrinsic load and pushes learners toward passive reading. Chunking the vocabulary and interleaving each term with a short activity (worked-example effect) reduces load.

Improvement Prompt (for an agent):

Edit workshop/04-github-actions-intro.md. Reduce new concepts introduced to ≤ 15 by keeping only trigger, job, runner, action and step as taught terms and moving the rest into a link to side-quest-05-01-actions-power-user.md. Move the "Why This Matters for Agentic Workflows" comparison to a two-sentence NOTE-free paragraph. Add one more hands-on activity (a code block or checklist item the learner completes) so activity density reaches ≥ 3 per 100 words. Keep the "Already know GitHub Actions?" skip block, the "## :white_check_mark: Checkpoint" section with ≥ 4 items, second-person voice, no numbered headings. Run npx --yes markdownlint-cli2 "workshop/04-github-actions-intro.md".

Expected Score After Fix: 6.5 / 10.0 (≈ 8.4 once the checkpoint detector is fixed)

Generated by 🔬 Curriculum Quality Evaluator · copilot · auto · ~46 AIC · ⌖ ~2 AIC · ⊞ 5K · ◷

  • expires on Nov 9, 2026, 3:31 AM UTC
主要语言
JavaScript
星标
58
派生
40
平均合并
4 天 4 小时
30 天内合并 PR
8

环境准备

在 Codespaces 中打开

在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

githubnext/gh-aw-workshop 的其他 Issue

查看 githubnext/gh-aw-workshop 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。