Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

markdownファイルの改行位置調整 #227

Merged
merged 3 commits into from
May 2, 2024

Conversation

quickper
Copy link
Contributor

@quickper quickper commented May 1, 2024

markdownのプレビューをしたとき、改行を期待するが改行されず、読みづらい箇所がある。改善する対応。

対応内容

  • リストまたは番号付きリストに変更した。
  • 「テストの対象となる達成基準 (複数)」はリストだと過剰と判断し、カンマ区切りに統一した。
  • markdown上は改行しているが、プレビューでは改行されていない箇所は、空白文字(改行)を追加し、プレビュー上でも改行されるように変更した。

メモ

@@ -128,8 +128,8 @@ H51
2. リンクを含むセルと関連付けられている行見出しを知るための何らかの手段が提供されている

# テスト実施時の注意点 (音声閲覧環境)
1. について、例えば “営業部連絡先一覧” のテーブルにおいて、 “ヒューストン” から “ピッツバーグ” へ移動すると、“ジョエル・ガーナー ピッツバーグ” と読み上げられる場合は OK と判断
また例えば “営業部連絡先一覧” のテーブルにおいて、 “ヒューストン” を読み上げた後、何らかのキー操作によって “ゴードン・グリーニッジ 住所 ヒューストン” と読み上げられる場合は OK と判断
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

リスト変更に伴い、本文を変更しました。

@@ -128,8 +128,8 @@ H51
2. リンクを含むセルと関連付けられている列見出しを知るための何らかの手段が提供されている

# テスト実施時の注意点 (音声閲覧環境)
例えば “営業部連絡先一覧” のテーブルにおいて、“281-511-6600” から “ヒューストン” へ移動すると、 “住所 ヒューストン” と読み上げられる場合は OK と判断
また例えば “営業部連絡先一覧” のテーブルにおいて、“ヒューストン” を読み上げた後、何らかのキー操作によって “ゴードン・グリーニッジ 住所 ヒューストン” と読み上げられる場合は OK と判断
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

リスト変更に伴い、本文を変更しました。

1.3.2
1.4.5
1.4.9
1.3.2, 1.4.5, 1.4.9, 2.4.1
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(意図があるかもしれませんが)2.4.1 を末尾に移動しました。

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

いいと思います

Comment on lines 77 to 97
送り先 1 の姓
送り先 1 の名
送り先 1 の住所
スイカ
花火
オリジナルスタンプ
メロディカード
送り先 1 のメッセージ
1 番目の受取人へのカードプレビュー
送り先 2 の姓
送り先 2 の名
送り先 2 の住所
スイカ
花火
オリジナルスタンプ
メロディカード
送り先 2 へのメッセージ
1 番目の受取人へのカードプレビュー
注文内容の確認
入力内容のリセット

1. 送り先 1 の姓
1. 送り先 1 の名
1. 送り先 1 の住所
1. スイカ
1. 花火
1. オリジナルスタンプ
1. メロディカード
1. 送り先 1 のメッセージ
1. 1 番目の受取人へのカードプレビュー
1. 送り先 2 の姓
1. 送り先 2 の名
1. 送り先 2 の住所
1. スイカ
1. 花火
1. オリジナルスタンプ
1. メロディカード
1. 送り先 2 へのメッセージ
1. 1 番目の受取人へのカードプレビュー
1. 注文内容の確認
1. 入力内容のリセット
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

markdown で連番をこう記述できるのはいいのですが、
閲覧環境によってはわかりにくいのではないか、と気になりました。
例えば諸熊さんのテストツールだと現状 master はこう読み込まれて表示されます。

image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

markdown ファイルの管理コストを優先してしまい、無配慮でした。下記のA案が無難かと思いますが、いかがでしょうか?

  • A案:連番に変更する(手順が増えたときに連番振り直しが手間だが、順番はわかりやすい)

    1. 送り先 1 の姓
    2. 送り先 1 の名
    3. 送り先 1 の住所
    
  • B案:番号付きリストをやめる

    - 送り先 1 の姓
    - 送り先 1 の名
    - 送り先 1 の住所
    
  • C案:改行を足す(ファイルは冗長になるし、諸熊さんツール上も改行が多くて見づらそう)

    送り先 1 の姓
    
    送り先 1 の名
    
    送り先 1 の住所
    
  • NG案:brタグを使う(GitHub のプレビューは問題ないが、閲覧環境に依存する)

    送り先 1 の姓<br>
    送り先 1 の名<br>
    送り先 1 の住所<br>
    

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

意味的にはリストが妥当ですが、管理コストの懸念もごもっともですし、
コンテンツ側にもすでに「送り先1」のように番号がついているので、
連番がないほうが混乱がない可能性もありますね。
私はB案でもいい気がします。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ありがとうございます、B案で統一しました。 改行の問題は解消できるので現状よりよさそうです。f87b884
(OK そうであれば autosquash します)

@nishimotz
Copy link
Contributor

まず表示が崩れているところに限って改善するという方針でいいと思います。
気になるのはコメントでも指摘した markdown の番号付きリストの表記方法でしょうか。
プレーンテキストとしては読みづらくなるので。

@quickper quickper force-pushed the fix-markdown-line-breaks branch from f87b884 to 09de77d Compare May 2, 2024 13:24
@quickper
Copy link
Contributor Author

quickper commented May 2, 2024

rebase 後に差分がないことを確認。 https://github.com/waic/as_test/compare/f87b8845e91ff4c3ab6bddb849ec34d4bf5673f2..09de77d51087fb7ccaf5cd075c5b3e3bdb1a7723

@nishimotz OK そうであれば merge お願いします🌞

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