Skip to content

docs: order the document-ecosystem table by reader interest#101

Merged
toshi0806 merged 1 commit into
mainfrom
reorder-doc-ecosystem-table
Jul 19, 2026
Merged

docs: order the document-ecosystem table by reader interest#101
toshi0806 merged 1 commit into
mainfrom
reorder-doc-ecosystem-table

Conversation

@toshi0806

Copy link
Copy Markdown
Member

概要

文書作成エコシステム表の行順を、読者の関心順(使うもの → 支えるもの → 運用するもの)の 3 グループに整理します(#100 のフォローアップ)。行の内容は変更なし、並べ替えのみです。

新しい順序

  1. テンプレート: sotsuron(旗艦)→ ise → poster → latex(汎用・添削オプション)
  2. 執筆環境・ビルド基盤(依存順): texlive-ja-textlint → latex-environment → aldc → latex-release-action → split-sentences(執筆支援)
  3. 管理・運用: latex-ecosystem(全体像の入口)→ student-repo-management → registry-manager → thesis-monitor → ecosystem-manager

従来は汎用テンプレートが先頭・旗艦の sotsuron-template が 3 番目で、split-sentences がテンプレート群と基盤群の間に孤立していました。

Group rows as templates (flagship first), writing/build
infrastructure (dependency order, with split-sentences as a writing
aid), then management tooling (ecosystem overview first).

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

このPRはドキュメントの表の行順を整理するものです。コードの動作には影響しない純粋なドキュメント変更であり、全体的に意図が明確で問題はありません。ただし、1点だけ確認すべき点があります。

Comment thread profile/README.md
| [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 サイクルはオプション) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ℹ️ [LOW] PR本文の「新しい順序」説明では sotsuron(旗艦) → ise → poster → latex(汎用) と記載されていますが、実際の差分では sotsuron → ise → poster → latex の順になっており、PR本文の説明と一致しています。

ただし、latex-template を「汎用・添削オプション」として最後に置く理由として「draft PR サイクルはオプション」という性質が挙げられていますが、読者によっては「汎用テンプレートが最初にあった方が入門しやすい」と感じる可能性もあります。sotsuron-template を旗艦として先頭に置く判断は理解できますが、latex-template をテンプレートグループの末尾にする根拠をREADME内のコメントや見出しで補足すると、将来の編集者が意図を誤解しにくくなります(現状はPR本文にしか説明がない)。

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

据え置きます。並び順の意図(グループ構成と各グループ内の順序基準)は本 PR の本文と commit message に記録しており、将来の編集者はそちらを参照できます。読者向けページに編集意図のコメントや説明を埋め込むことはしない方針です(文書には現在の姿だけを書き、経緯・根拠は PR / commit に残す)。

@toshi0806

Copy link
Copy Markdown
Member Author

AI レビュー指摘への対応まとめ

review(AI Review): success。指摘は LOW 1 件のみで、据え置きで収束しました(スレッドに返信済み):

  • 並び順の意図を README 内で補足せよ — 据え置き。意図は PR 本文・commit message に記録済みで、読者向けページに編集意図のメタ情報は埋め込まない方針のため

マージ可能な状態です。

@toshi0806
toshi0806 merged commit 6e1656a into main Jul 19, 2026
2 checks passed
@toshi0806
toshi0806 deleted the reorder-doc-ecosystem-table branch July 19, 2026 11:24
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.

1 participant