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

目次のネストを1段階に固定する #810

Closed
Seasawher opened this issue Sep 17, 2024 · 5 comments · Fixed by #832
Closed

目次のネストを1段階に固定する #810

Seasawher opened this issue Sep 17, 2024 · 5 comments · Fixed by #832
Assignees
Labels
help wanted Extra attention is needed 本文 開発

Comments

@Seasawher
Copy link
Member

lean ja で相談したこれの件


Lean by Example のレイアウトに関して思ったのですが、構文カテゴリの分類の正確性について妥協して、
すべての見出しのネストレベルを1にすると見やすくなるのではないでしょうか?

たとえば、現状 #check コマンドは コマンド > 対話的コマンド > #check という階層になっていますが、
親カテゴリの「コマンド」をなくして 対話的コマンド > #check という配置にします。

型クラスの ToString も、現状では 項 > 型クラス > ToString という階層ですが、
親カテゴリの「項」をなくして一つ階層をあげて 型クラス > ToString という配置にします。

これによるメリットは、階層が揃うことによって目当ての記事を探すときのクリックの仕方が固定されて記事が探しやすくなること、
各見出し語を折りたたんだ時にだいたい興味のあるカテゴリを全部一覧できることが挙げられます。

特に一覧性は上がりそうです。対話的コマンド、宣言的コマンド、属性、タクティク、型クラス、型、演習問題という順にカテゴリが並ぶことになり、たとえば属性の記事を探したいひとにとっては、今まではそれがコマンドのサブカテゴリであることを見抜く必要があったのですが、それがなくなるので読者が自分で考えなければならないことが減ります。

デメリットは、構文カテゴリ分類の正確性が損なわれることですが、これについてはそう心配するほどでもないかなと思いました。そもそも分類は目当ての記事にたどり着くことができればよいわけなので、分類を気にしすぎて見づらくなったら本末転倒です。
また、別のデメリットとしてリンク切れが大量に発生することが挙げられます。これについてはすみません…。本件に限らず Lean by Example はまだ内容が安定していないので、リンクされる際は個別記事ではなくトップページへのリンクを推奨いたします。

いかがでしょうか?利用者の観点からご意見があればうかがいたいです。

@Seasawher Seasawher added help wanted Extra attention is needed 本文 開発 labels Sep 17, 2024
@Seasawher
Copy link
Member Author

Seasawher commented Sep 17, 2024

👍 さらなるメリット

これは実は内部リンクの複雑性の問題( #639 )を同時に解決する。
ネストの深さが項目によって異なるのが原因だったため。

@Seasawher
Copy link
Member Author

Seasawher commented Sep 17, 2024

👍 さらなるメリット

見出しを折りたたんだ状態をデフォルトにするかどうかの問題 ( #790 ) との関連。

見出し語を折り畳む形式のレイアウトと相性がよくなる。折り畳むようにすれば現状のようにずらーっと項目を並べずに済むので良いと思われる。(初心者に圧迫感を与えている可能性がある?)

@Seasawher
Copy link
Member Author

Seasawher commented Sep 17, 2024

👍 さらなるメリット

見出しの構成が初心者に優しくなることが期待できる。

たとえば、詳しい人は属性を探すときに項のページは見ないけど、初心者はそうでもない。ネストされていることにより、構文カテゴリについての知識が要求されてしまうので、初心者フレンドリーでなくなってしまう。

@Seasawher
Copy link
Member Author

Seasawher commented Sep 17, 2024

👍 さらなるメリット

階層が深くなると見出し語の文字数制限がきつくなってしまう。ネストが2段階になるだけで相当きつい。
1段階なら緩くなるので、見出し語の一言説明をより正確なものにできる

@Seasawher

This comment was marked as abuse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed 本文 開発
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant