Skip to content

docs(manual): 使い方マニュアルを 43 枚の画面写真つきで足す - #65

Merged
GIGAyama merged 1 commit into
mainfrom
claude/app-manual-portal-display-nctaq8
Aug 31, 2026
Merged

docs(manual): 使い方マニュアルを 43 枚の画面写真つきで足す#65
GIGAyama merged 1 commit into
mainfrom
claude/app-manual-portal-display-nctaq8

Conversation

@GIGAyama

Copy link
Copy Markdown
Owner

何をしたか

docs/manual/manual.md を新しく置きました。giga-manual スキルの書式どおり、
19 章 50 節・本文 12,806 字・画面写真 43 枚です。

読み手は児童です(data/apps.jsongrades[2,3,4])。いちばん下の学年に
合わせて、3 年以上の配当漢字と表外字 298 か所にふりがなを振ってあります。

あわせて、アプリの画面からマニュアルへ行けるようにしました。

章立て

  1. Typa(タイパ)で できること
  2. はじめて ひらく ときに する こと(さいしょの 1回だけ)
  3. うつ がめんの みかた
  4. キーを 打つ ときの きまり
  5. ひとまわりと ★の つきかた
  6. れんしゅうを やめて、けっかを 見る
  7. 「えらぶ」から やる ことを きめる
  8. きょうの ふくしゅうを する
  9. にがて とっくんで、まちがえた キーだけ 打つ
  10. チャレンジで、じかんの 中で どれだけ 打てるか ためす
  11. ショートカットの ステージで、コピーと はりつけを おぼえる
  12. ぜんぶ ★3つに なった あと(だん)
  13. じぶんの きろくを 見る(下の バーの「きろく」)
  14. ヒントの つよさを かえる(せってい →「ヒント」)
  15. 見た目と 音を かえる(せってい →「みため」)
  16. キーボードの ならびを 合わせる(せってい →「キーボード」)
  17. きろくを べつの 端末へ うつす・ぜんぶ けす(せってい →「データ」)
  18. うまく いかない ときは
  19. 先生へ(クラスで つかう ときと、印刷)

画面写真

43 枚すべて、実ブラウザで操作して撮っています。コードから書いた画面は 1 枚もありません。

  • ★3 つになった瞬間の自動送り(10-lap-star3 / 11-auto-next
  • 同じお題で 4 回まちがえたときの「この お題を とばす」(07-miss / 08-skip
  • かな入力になっているときの赤いおしらせ(09-ime-warn
  • にがて とっくん・チャレンジ 30 びょう・ローマ字ひょう
  • ショートカットは本物の Ctrl+A / C / V を押して 4/4 まで通しました
  • 32 ステージすべてを ★3 つにしたあとの「そのさき」と「だん」(42-review / 43-rank

引きの絵(画面まるごと)と寄りの絵(.play-head #play-finger .navbar など 6 枚)を
分けてあります。印刷すると画面写真は縦 92mm に縮むので、全景 1 枚では字が読めません。

アプリ側の変更

  • index.htmlgiga-app-links.jsdata-links="terms,privacy" を外しました。
    マニュアルができたので、部品の既定(つかいかた・利用規約・プライバシー)を
    そのまま出します。行き先は giga-school.com/apps/typa/manual/ で、
    毎朝ポータルが docs/manual/manual.md から組み直します。
    この属性は「マニュアルを書いたら消す」とコード中のコメントに書いてあったものです。
  • js/app.js … せってい →「データ」の「使い方を 読む」を
    「しょうかいページを 読む」に直しました。行き先は紹介ページ(/apps/typa/)のままです。
    同じ画面に「つかいかた」と「使い方」が並んで別の場所を指す形を避けるためです。
  • docs/CHANGELOG.md … 新しく置きました(使う人から見て、リンクが 1 本増えます)。
  • sw.js … 版を刻み直しました(vf8014ab1vfd947b6d)。

通した検査

検査 結果
npm run check 44 件すべて通過
npm test 5 件すべて通過
node tools/build-sw.mjs --check 版は最新
lint-manual.mjs docs/manual/manual.md エラー 0・警告 0
lint-changelog.mjs docs/CHANGELOG.md 通過
lint-giga.mjs(Zero-CDN / Zero-PII) 通過

そのうえで、公開と同じ組み立て(ポータルの renderArticle + manualPage)で
ページにして実ブラウザで見ました。

  • 図 43・キャプション 43・h2 19・h3 50・目次 69 行(上限の目安 70 行いない)
  • <ruby> 318 個が正しく組まれ、字としてそのまま出たものは 0 件
  • 見出しの直後がいきなり写真になっている節は 0 件
    (本文がキャプションに降格する事故を避けるため、最初に 5 か所直しました)
  • 「学校で使うときは」はページ側が data/apps.json から足しています(手書きしていません)
  • A4 で 52 ページ・1 章あたり 2.7 ページ。半分白いページは出ていません

事実の突き合わせ

本文の言い切っている文は、コード側から読み直して確かめました。
★の線(98% / 92% / 80%、またはミス 1 / 2 / 3 回まで)、ふくしゅうの間隔(1→3→7→14→30 日)、
にがて とっくんの条件(まちがえたキー 2 つ、またはとりちがえ 1 くみ)と上限 16 もん、
だんの条件(ヒント × はやさ)、バッジ 24 種、レベル 7 段、コース 5・ステージ 32 ――
すべて js/lessons.js js/store.js js/awards.js js/play.js に当てました。

見ていただきたいところ

  • 画面写真が 14MB あります。 2400×1640 の PNG 43 枚です。この環境に画像を
    縮める道具(pngquant / optipng / Pillow)が無かったので、撮ったままです。
    マイ漢字タウン(40 枚)や Qalc(56 枚)と同じくらいですが、減らしたほうがよければ直します。
  • ふりがなは、書き捨てのスクリプトで 2 つとも機械で確かめました。
    ①ルビを外すと元の本文に 1 バイトも違わず戻る ②ルビの外に 3 年以上の漢字が残っていない。
  • 章の順番は公開後に入れ替えられません(#s-N は位置の連番なので、
    外から張られたリンクと印刷物がずれます)。並べ直しの都合がつくのはマージ前だけです。

🤖 Generated with Claude Code

https://claude.ai/code/session_01GArPzFS7PNfd4dqbKgsxDo


Generated by Claude Code

docs/manual/manual.md を新しく置いた。giga-manual スキルの書式に沿って、
19 章 50 節・本文 12,806 字・画面写真 43 枚。読み手は児童なので
(data/apps.json の grades が [2,3,4])、3 年以上の配当漢字と表外字
298 か所にふりがなを振ってある。

画面写真はすべて実ブラウザで操作して撮った。★3 つの自動送り、
4 回まちがえたときの「とばす」、かな入力の警告、にがて とっくん、
チャレンジ、ショートカット(本物の Ctrl+A / C / V)、32 ステージ
すべて ★3 つにしたあとの「だん」まで、実際に触った画面だけを載せている。

アプリ側からマニュアルへ行けるようにした。index.html の
giga-app-links.js から data-links を外し、部品の既定(つかいかた・
利用規約・プライバシー)をそのまま出す。「つかいかた」の行き先は
giga-school.com/apps/typa/manual/ で、毎朝ポータルが docs/manual/manual.md
から組み直す。

せってい →「データ」の「使い方を 読む」は紹介ページ(/apps/typa/)を
指していたので、「しょうかいページを 読む」に直した。同じ画面に
「つかいかた」と「使い方」が並んで別の場所を指す形を避ける。

- npm run check 44 件 / npm test 5 件 / lint-manual 警告 0 件
- sw.js の版を刻み直した(vf8014ab1 → vfd947b6d)

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GArPzFS7PNfd4dqbKgsxDo
@GIGAyama
GIGAyama marked this pull request as ready for review August 31, 2026 20:02
@GIGAyama
GIGAyama merged commit 3fb4af5 into main Aug 31, 2026
2 checks passed
@GIGAyama
GIGAyama deleted the claude/app-manual-portal-display-nctaq8 branch August 31, 2026 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants