Summary: External facts such as the shared glossary, tool versions, upstream metadata. Reference documents contain fixed information that other documents link to. 概要: 共通用語集、道具の版、上流メタデータなどの外部事実。参考文書は他の文書がリンクする固定情報を持ちます。
- Version / 版: 0.1 — 2026-11-05. Learned: a shared glossary is needed because the same term (for example "upstream" or "port") appears in several specifications and must mean one thing everywhere. / 同じ用語(例:「上流」「ポート」)が複数の仕様に出てくるため、どこでも一つの意味になるよう共通の用語集が必要だと分かった。
- Normative for: REF-01 Glossary and future reference documents.
- Related: ../README.md · policy/ · spec/ · decisions/
A reference document contains external facts that other documents link to. This folder contains:
| ID | File | Purpose |
|---|---|---|
| REF-01 | REF-01_Glossary.md | The shared glossary: technical terms with one-line notes for everyone and precise meanings for engineers. |
Future reference documents may include:
| ID | Topic |
|---|---|
| REF-02 | Tool versions and compatibility matrix |
| REF-03 | Upstream repository metadata (default branches, tags) |
Reference documents are linked from other documents using relative links:
- Glossary terms:
[term](../reference/REF-01_Glossary.md#english)(section anchor) - Tool versions:
[docker](../reference/REF-02_Tool_Versions.md#english)(file link)
- Name the file
REF-NN_<Title>.md(two-digit number, next available). - Follow SPEC-06 documentation conventions.
- Include only fixed facts, not opinions or processes.
- Link from documents that need the reference.
「参考」文書は他の文書がリンクする外部事実を含みます。このフォルダには次が含まれます:
| ID | ファイル | 目的 |
|---|---|---|
| REF-01 | REF-01_Glossary.md | 共通用語集:専門用語に、誰向けに一行の注と技術者向けの正確な意味を付ける。 |
今後の参考文書として以下が考えられます:
| ID | トピック |
|---|---|
| REF-02 | 道具の版と互換性マトリクス |
| REF-03 | 上流リポジトリメタデータ(既定ブランチ、タグ) |
参考文書は他の文書から相対リンクで参照されます:
- 用語集の語:
[用語](../reference/REF-01_Glossary.md#japanese)(節アンカー) - 道具の版:
[docker](../reference/REF-02_Tool_Versions.md#japanese)(ファイルリンク)
- ファイル名を
REF-NN_<題>.md(2 桁の番号、次に空いているもの)にする。 - SPEC-06 文書規約に従う。
- 意見やプロセスではなく、固定事実だけを含む。
- 参考が必要な文書へリンクする。
| Term | English note | 日本語注 |
|---|---|---|
| Reference | A document containing external facts that other documents link to. | 他の文書がリンクする外部事実を含む文書。 |
| Glossary | A collection of technical terms with explanations. | 専門用語の集合。 |
| Link | A navigational element that jumps to another part of a document. | 文書の別の部分へ飛ぶナビゲーション要素。 |
| Anchor | A bookmark inside a page that a link can jump to. | ページの中の「しおり」。リンクで飛べる。 |