Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[curriculum-eval] 04-github-actions-intro.md: cognitive_load — redundant YAML example doubles concept count in labeling exercise

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

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

阅读 workshop/04-github-actions-intro.md,重点关注“Label a sample workflow”和“Why This Matters for Agentic Workflows”部分,然后将其与上方带注释的示例进行比较。从练习中删除重复的 YAML,并按要求缩短比较表,保持指定部分不变。运行 markdownlint-cli2;练习仍应要求学习者为五行添加标签,表格只保留 Trigger 和 Steps。

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

描述

curriculum documentation quality

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

Flagged Dimensions:

Dimension Score Benchmark Delta
cognitive_load 6.8 ≤ 15 new concepts −6.5 concept penalty (28 new concepts, nearly double budget, in only 756 words)
active_learning 3.9 density ≥ 3 −6.1 (density 1.19)

Root Cause (≤ 2 sentences):
This is the corpus's highest new-concept-per-word page outside the anthropic-key side quest — 28 bolded/code terms in 756 words — because it simultaneously introduces Actions vocabulary (trigger, job, runner, step, action), a full annotated YAML example, a second "label the five parts" exercise with its own five-line YAML, and an Actions-vs-agentic comparison table, each contributing new terms in quick succession. The "Label a sample workflow" exercise repeats four of the five terms already defined in the "Quick Refresher" section and annotated example just above it, adding redundant vocabulary load rather than new content.

Evidence (quoted from the file):

"on: [push] / jobs: test: ... Write a label beside each line: 1. on: [push] 2. test: (the job name under jobs:) 3. runs-on: ubuntu-latest 4. uses: actions/checkout@v4 5. run: echo \"All checks passed\"" (a second full YAML example restating trigger/job/runner/step/action after they were already defined and shown in the first annotated example)

Learning Science Rationale:
Cognitive Load Theory's redundancy effect states that presenting the same information in two different forms (an annotated code block, then a nearly identical un-annotated code block for labeling) increases extraneous load without adding germane learning value, because learners must reprocess information they already encoded. Removing the duplicate "Hello Workflow" YAML in the labeling exercise and instead asking learners to label the already-annotated example consolidates this page's concept count under budget while preserving the retrieval-practice benefit of the labeling activity.

Improvement Prompt (for an agent):

Edit workshop/04-github-actions-intro.md to reduce concept load:
1. In the "## Label a sample workflow" section, remove the second
   "```yaml .github/workflows/hello-workflow.yml``` on: [push] / jobs: test: ..."
   code block, since it duplicates the "Annotated example" code block above it almost
   term-for-term. Instead have the exercise instruction say "Using the annotated example
   above, write a label beside each of these five lines" and reference the five lines by
   quoting them inline rather than repeating the full YAML block.
2. Shorten the "Why This Matters for Agentic Workflows" comparison table to the 2 rows
   most relevant to this page (Trigger, Steps) and move the remaining rows (Runner,
   Output) to 05-agentic-workflows-intro.md where they are covered in more depth, to
   avoid introducing extra comparison vocabulary twice in one page.
Keep the "what is a runner?" <details> block, the "Try it" exercise, and the Checkpoint
section unchanged. Re-run markdownlint-cli2 after editing.

Expected Score After Fix: 6.3–6.7 / 10.0

Generated by 🔬 Curriculum Quality Evaluator · copilot · auto · 119.1 AIC · ⌖ 17.8 AIC · ⊞ 10.4K · ◷

  • expires on Oct 13, 2026, 4:04 AM UTC
主要语言
JavaScript
星标
53
派生
35
平均合并
13 小时 50 分钟
30 天内合并 PR
14

环境准备

在 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 摘要。