docs(manual): 使い方マニュアルを 43 枚の画面写真つきで足す - #65
Merged
Conversation
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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
何をしたか
docs/manual/manual.mdを新しく置きました。giga-manual スキルの書式どおり、19 章 50 節・本文 12,806 字・画面写真 43 枚です。
読み手は児童です(
data/apps.jsonのgradesが[2,3,4])。いちばん下の学年に合わせて、3 年以上の配当漢字と表外字 298 か所にふりがなを振ってあります。
あわせて、アプリの画面からマニュアルへ行けるようにしました。
章立て
画面写真
43 枚すべて、実ブラウザで操作して撮っています。コードから書いた画面は 1 枚もありません。
10-lap-star3/11-auto-next)07-miss/08-skip)09-ime-warn)Ctrl+A/C/Vを押して 4/4 まで通しました42-review/43-rank)引きの絵(画面まるごと)と寄りの絵(
.play-head#play-finger.navbarなど 6 枚)を分けてあります。印刷すると画面写真は縦 92mm に縮むので、全景 1 枚では字が読めません。
アプリ側の変更
index.html…giga-app-links.jsのdata-links="terms,privacy"を外しました。マニュアルができたので、部品の既定(つかいかた・利用規約・プライバシー)を
そのまま出します。行き先は
giga-school.com/apps/typa/manual/で、毎朝ポータルが
docs/manual/manual.mdから組み直します。この属性は「マニュアルを書いたら消す」とコード中のコメントに書いてあったものです。
js/app.js… せってい →「データ」の「使い方を 読む」を「しょうかいページを 読む」に直しました。行き先は紹介ページ(
/apps/typa/)のままです。同じ画面に「つかいかた」と「使い方」が並んで別の場所を指す形を避けるためです。
docs/CHANGELOG.md… 新しく置きました(使う人から見て、リンクが 1 本増えます)。sw.js… 版を刻み直しました(vf8014ab1→vfd947b6d)。通した検査
npm run checknpm testnode tools/build-sw.mjs --checklint-manual.mjs docs/manual/manual.mdlint-changelog.mjs docs/CHANGELOG.mdlint-giga.mjs(Zero-CDN / Zero-PII)そのうえで、公開と同じ組み立て(ポータルの
renderArticle+manualPage)でページにして実ブラウザで見ました。
h219・h350・目次 69 行(上限の目安 70 行いない)<ruby>318 個が正しく組まれ、字としてそのまま出たものは 0 件(本文がキャプションに降格する事故を避けるため、最初に 5 か所直しました)
data/apps.jsonから足しています(手書きしていません)事実の突き合わせ
本文の言い切っている文は、コード側から読み直して確かめました。
★の線(98% / 92% / 80%、またはミス 1 / 2 / 3 回まで)、ふくしゅうの間隔(1→3→7→14→30 日)、
にがて とっくんの条件(まちがえたキー 2 つ、またはとりちがえ 1 くみ)と上限 16 もん、
だんの条件(ヒント × はやさ)、バッジ 24 種、レベル 7 段、コース 5・ステージ 32 ――
すべて
js/lessons.jsjs/store.jsjs/awards.jsjs/play.jsに当てました。見ていただきたいところ
縮める道具(pngquant / optipng / Pillow)が無かったので、撮ったままです。
マイ漢字タウン(40 枚)や Qalc(56 枚)と同じくらいですが、減らしたほうがよければ直します。
①ルビを外すと元の本文に 1 バイトも違わず戻る ②ルビの外に 3 年以上の漢字が残っていない。
#s-Nは位置の連番なので、外から張られたリンクと印刷物がずれます)。並べ直しの都合がつくのはマージ前だけです。
🤖 Generated with Claude Code
https://claude.ai/code/session_01GArPzFS7PNfd4dqbKgsxDo
Generated by Claude Code