[curriculum-eval] side-quest-01-02-environment-reference.md: cognitive_load — 1,536 words and 19 concepts in one reference page

未关闭 适合新手
  • 哪里不对？
#5,711 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

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

调研方向

从 workshop/side-quest-01-02-environment-reference.md 开始：需要移动或精简的部分是包含 Docs 列的术语表，以及“Conceptual screenshots”一节。在术语表之后添加一个“Try it”命令块；如果新增了页面，请更新 workshop/README.md。完成标准是：页面少于 900 个单词，新页面已存在并已链接，且 npx markdownlint-cli2 "**/*.md" 检查通过。

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

描述

curriculum documentation quality

File: workshop/side-quest-01-02-environment-reference.md
Overall Score: 4.79 / 10.0 (corpus mean: 6.06)

Flagged Dimensions:

Dimension Score Benchmark Delta
cognitive_load 5.3 ≥ 8 (≤ 800 words, ≤ 15 concepts) −2.7 (1,536 words, 19 concepts)
active_learning 2.4 density ≥ 3 −0.6 (density 0.72)

(checkpoint_quality 0.0 and scaffolding 5.0 are false negatives from the rubric regex; the page has both sections.)

Root Cause (≤ 2 sentences):
The page puts a long glossary table and a long run of "conceptual screenshots" on one page (1,536 words, about 2x the 800-word ideal), with little learner action beyond the checkpoint. It is the lowest-scoring page in the corpus and trending slightly down (4.93 → 4.79).

Evidence (quoted from the file):

| GitHub Codespaces | Your cloud development environment when you choose the browser-based setup path. Pre-launched in golden-ticket workshops. | Steps 2–14: writing, compiling, and running workflows | GitHub Codespaces docs |

Learning Science Rationale:
Sweller's Cognitive Load Theory predicts that a dense four-column table with an external link in every row raises extraneous load and splits attention. Mayer's segmenting and coherence principles suggest splitting the reference into smaller chunks and dropping redundant material. Short "try it" checks (gh --version) placed next to each tool would add retrieval practice.

Improvement Prompt (for an agent):

Edit workshop/side-quest-01-02-environment-reference.md. Reduce it to under 900 words: move the "Conceptual screenshots" section into a new side quest page (e.g. side-quest-01-04-environment-screenshots.md) and link to it, and remove the "Docs" column from the glossary table, linking each tool name inline instead. Add a short "Try it" command block (gh --version, git --version, gh auth status) directly after the glossary. Keep the existing "Before You Start" and Checkpoint sections (use the :white_check_mark: shortcode heading). Update workshop/README.md if a page is added. Run: npx --yes markdownlint-cli2 "**/*.md".

Expected Score After Fix: 7.0 / 10.0

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

  • expires on Nov 15, 2026, 7:04 AM UTC
主要语言
JavaScript
星标
62
派生
43
平均合并
11 小时 26 分钟
30 天内合并 PR
13

环境准备

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