Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[curriculum-eval] side-quest-01-02-environment-reference.md: cognitive_load — 1433-word reference page repeats every tool description twice

クローズ 初心者向け
#3,852 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
markdown
領域
documentation

調査の方向性

workshop/side-quest-01-02-environment-reference.md を、用語集の表と「Conceptual screenshots」セクションから始めて編集します。表と重複する説明文だけを削除し、画像、用語集、チェックポイントのチェックリストは残します。npx --yes markdownlint-cli2 "**/*.md" を実行します。完了時点で、ページは 800~1000 語に近づき、lint にも合格します。

索引モデルが issue の本文から書いたものです。

説明

curriculum documentation quality

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

Flagged Dimensions:

Dimension Score Benchmark Delta
cognitive_load 6.3 ≤ 800 words −3.7 (1433 words, 633 over ideal)
active_learning 2.1 density ≥ 3 −7.9 (density 0.63)
readability (fk_grade) 10.0 grade 8–12 0 (10.7, within range — not a real problem)

Note: checkpoint_quality is reported as 0.0/has_checkpoint: false due to a confirmed tooling regex bug (see companion issue on curriculum_assessment.py) — this file has a ## :white_check_mark: Checkpoint section with 7 items. Excluded from this finding.

Root Cause (≤ 2 sentences):
This reference page is nearly double the ideal word budget (1433 vs. 800 words) because it repeats every tool twice — once in the glossary table and again in a full "Conceptual screenshots" section with its own paragraph per tool — and the ten image call-outs contribute almost no code blocks or checklist items, so activity density stays very low for a long page.

Evidence (quoted from the file):

| GitHub Codespaces | Your cloud development environment when you choose the browser-based setup path... |

GitHub Codespaces

(picture)...<img alt="Conceptual screenshot of GitHub Codespaces..." .../>(/picture)
You use Codespaces when you want a ready-to-go development environment in your browser.

Nine of the ten glossary rows are followed by an almost identical one-sentence restatement under the "Conceptual screenshots" heading, doubling word count without adding new information.

Learning Science Rationale:
Mayer's redundancy principle states that presenting the same explanation in text twice (once in a table, once in prose beside an image) does not aid learning and instead adds unnecessary reading load, since the image plus a single caption already conveys the "when you use it" information the table row states. As an optional reference page this is lower-stakes than a core lesson, but trimming the duplicated prose would let learners scan the page faster, which matters for its intended "look something up quickly" use case.

Improvement Prompt (for an agent):

Edit workshop/side-quest-01-02-environment-reference.md to remove redundant text and shorten the page toward 800-1000 words:

1. For each tool in the "Conceptual screenshots" section, replace the standalone explanatory sentence (e.g., "You use Codespaces when you want a ready-to-go development environment in your browser.") with a single-line image caption only if it adds information not already in the glossary table's "What it means" / "When you use it" columns. If the sentence merely restates the table row, delete it and rely on the table plus the image alt text.
2. Keep the glossary table as the single source of truth for definitions; keep the screenshots section focused only on visual recognition ("this is what X looks like"), not re-explaining what each tool does.
3. Do not remove the images, the glossary table, or the ## :white_check_mark: Checkpoint checklist — only trim duplicated prose.
4. Re-run npx --yes markdownlint-cli2 "**/*.md" after editing.

Expected Score After Fix: 6.6 / 10.0

Generated by 🔬 Curriculum Quality Evaluator · copilot · auto · 84.8 AIC · ⌖ 7.78 AIC · ⊞ 9K · ◷

  • expires on Sep 27, 2026, 8:49 AM UTC
主要言語
JavaScript
スター
55
フォーク
36
平均マージ
2日 6時間
マージ済み PR(30日)
18

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile・Docker Compose ファイルなし
  • プルリクエストのテンプレートなし
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

githubnext/gh-aw-workshop のほかの issue

githubnext/gh-aw-workshop の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。