テスト手順の書式を揃える

[nishimotz]

WAIC-TEST-0056-01.md が諸熊さんのテスト支援ツールで読み込めなかったという話から、
見出し構造や見出しの表記のルール化をしたいという話に。

現状、見出しのレベルの構造が統一されていない。

諸熊さんのツールの処理

• 見出しの文字列のマッチングを行っている。
• 例えば「期待される結果 (視覚閲覧環境)」「期待される結果 (音声閲覧環境)」でなくてはならない。

WAIC-TEST-0056-01 には「期待される結果」が2個あり、想定した処理が失敗している。

[nishimotz]

関連する達成基準、達成方法など、箇条書きとカンマ区切りの記法のブレをなくす。

マニュアルを整備しつつ、自動チェックなどを検討する。

[kubosho]

下記のPull RequestではMarkdownlintのルールに従うよう書かれていたので、GitHub Actionsを用いてlintのworkflowを作るのはありかもしれません。

• C18 / 0056-01 のテストを追加 #218

[kubosho]

GitHub Actionsを用いてlintのworkflowを作るのはありかもしれません。

こちら私がやります！

[kubosho]

MarkdownlintのRulesも見て、どういったルールが設定できるか確認しつつ、どういったルールが欲しいかも聞いた上で整備する予定です。

[kubosho]

どういったルールが欲しいか

まずはこのリポジトリ内のPull Requestを見てみて、書式でどういった指摘が多いかを挙げてみます。
目標は次のWG2定例までにまとめておきたいですが、2024年1月は1月15日が定例になりそうでしょうか？
（普段だと1月8日が定例の日になりそうですが、休み明けの人や休み中の人もいそうで、集まりが悪そうな印象です）

[nishimotz]

定例は今週です。出席が少ないも知れなませんが。

[kubosho]

返信遅くなってすいません。ちょっと今日の定例までにまとめるのは厳しいですが、今月中には下記の部分やっておきます。

リポジトリ内のPull Requestを見てみて、書式でどういった指摘が多いかを挙げてみます

---

遅くなりましたが、Pull Requestをコメントが多い順に上から見ていって、指摘内容とそれに対応するlintルールをまとめました。

• Markdownlintの検知対象を拡張する #294

[kubosho]

今日の定例までにまとめるのは厳しいですが、今月中には下記の部分やっておきます。

リポジトリ内のPull Requestを見てみて、書式でどういった指摘が多いかを挙げてみます

こちら1月中にはやっておきますと書きましたが、すいませんできておりません。
また自分の周りもバタバタしているため、いつできそうかが現状確約できない状態です。
ただ最終的にmarkdownlintを使ったGitHub Actionsのワークフローを組むという部分はやり切る予定です。

[nishimotz]

以下を将来の課題としたいです

• 既存のテストの手順と期待される結果を対にする #174 (comment)
• 音声閲覧環境: テスト手順1 / 期待される結果1 / テスト手順2 / 期待される結果2 ... のような構造を定義できるか

[nishimotz]

#142 で「視覚」と「音声」を共通化する見出し構造が提案されており、これを定義に取り入れるかどうか。