docs: order the document-ecosystem table by reader interest#101
Merged
Conversation
Group rows as templates (flagship first), writing/build infrastructure (dependency order, with split-sentences as a writing aid), then management tooling (ecosystem overview first).
| | [ise-report-template](https://github.com/smkwlab/ise-report-template) | 情報科学演習レポート用テンプレート(HTML5) | | ||
| | [poster-template](https://github.com/smkwlab/poster-template) | 学会発表用 A0 ポスターテンプレート(tikzposter・日本語対応) | | ||
| | [split-sentences](https://github.com/smkwlab/split-sentences) | LaTeX 文書を 1 文 1 行に整形し diff を見やすくするツール | | ||
| | [latex-template](https://github.com/smkwlab/latex-template) | 汎用 LaTeX ドキュメントテンプレート(draft PR サイクルはオプション) | |
There was a problem hiding this comment.
ℹ️ [LOW] PR本文の「新しい順序」説明では sotsuron(旗艦) → ise → poster → latex(汎用) と記載されていますが、実際の差分では sotsuron → ise → poster → latex の順になっており、PR本文の説明と一致しています。
ただし、latex-template を「汎用・添削オプション」として最後に置く理由として「draft PR サイクルはオプション」という性質が挙げられていますが、読者によっては「汎用テンプレートが最初にあった方が入門しやすい」と感じる可能性もあります。sotsuron-template を旗艦として先頭に置く判断は理解できますが、latex-template をテンプレートグループの末尾にする根拠をREADME内のコメントや見出しで補足すると、将来の編集者が意図を誤解しにくくなります(現状はPR本文にしか説明がない)。
Member
Author
There was a problem hiding this comment.
据え置きます。並び順の意図(グループ構成と各グループ内の順序基準)は本 PR の本文と commit message に記録しており、将来の編集者はそちらを参照できます。読者向けページに編集意図のコメントや説明を埋め込むことはしない方針です(文書には現在の姿だけを書き、経緯・根拠は PR / commit に残す)。
Member
Author
AI レビュー指摘への対応まとめ
マージ可能な状態です。 |
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.
概要
文書作成エコシステム表の行順を、読者の関心順(使うもの → 支えるもの → 運用するもの)の 3 グループに整理します(#100 のフォローアップ)。行の内容は変更なし、並べ替えのみです。
新しい順序
従来は汎用テンプレートが先頭・旗艦の sotsuron-template が 3 番目で、split-sentences がテンプレート群と基盤群の間に孤立していました。