Skip to content

Commit 18ec4c1

Browse files
docs: refine CX specification boundaries [skip-ci]
- replace local absolute links with relative links in CX docs - reduce BenchKit detail in CX_PLATFORM and delegate to BENCHKIT_SPEC - rename BenchKit structure sections to layer-oriented headings
1 parent 4bb32dd commit 18ec4c1

3 files changed

Lines changed: 34 additions & 56 deletions

File tree

docs/cx/BENCHKIT_SPEC.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If any discrepancy exists, the Japanese version takes precedence.
1111

1212
## 読み方のルール / Reading Conventions
1313

14-
本書では、[`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) の読み方のルールに従う。
14+
本書では、[`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) の読み方のルールに従う。
1515
特に、本書では以下を区別して読むことが重要である。
1616

1717
- 必須要件:
@@ -21,7 +21,7 @@ If any discrepancy exists, the Japanese version takes precedence.
2121
- 将来拡張:
2222
申請フォーム、自動 PR、AI 駆動最適化、MCP 連携などの拡張方向。
2323

24-
This document follows the reading conventions defined in [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md).
24+
This document follows the reading conventions defined in [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md).
2525
In particular, it is important here to distinguish:
2626

2727
- mandatory requirements:
@@ -56,16 +56,16 @@ BenchKit is responsible in particular for:
5656

5757
## 1.1 文書の位置づけ / Position of This Document
5858

59-
本書は、[`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) および [`CX_PLATFORM.md`](C:/Users/yoshi/benchkit/docs/cx/CX_PLATFORM.md) を受けて、BenchKit 自体の責務・構成・接続点を定義する下位仕様である。
59+
本書は、[`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) および [`CX_PLATFORM.md`](./CX_PLATFORM.md) を受けて、BenchKit 自体の責務・構成・接続点を定義する下位仕様である。
6060

6161
本書は、BenchKit の外にある外部サービス、外部ツール、実システムを前提とするが、
6262
それらの内部仕様そのものではなく、BenchKit から見た責務境界と接続要件を記述する。
63-
主要用語は [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) の用語集に従う。
63+
主要用語は [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) の用語集に従う。
6464

65-
This document is a lower-level specification derived from [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) and [`CX_PLATFORM.md`](C:/Users/yoshi/benchkit/docs/cx/CX_PLATFORM.md), defining BenchKit’s own responsibilities, structure, and integration points.
65+
This document is a lower-level specification derived from [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) and [`CX_PLATFORM.md`](./CX_PLATFORM.md), defining BenchKit’s own responsibilities, structure, and integration points.
6666

6767
It assumes the existence of external services, external tools, and real systems outside BenchKit, but describes not their internal semantics themselves, rather the responsibility boundaries and integration requirements as seen from BenchKit.
68-
Core terminology follows the glossary in [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md).
68+
Core terminology follows the glossary in [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md).
6969

7070
## 2. CX基盤における位置づけ / Position Within the CX Platform
7171

@@ -168,7 +168,7 @@ BenchKit must explicitly handle their integration conditions, assumptions, and i
168168

169169
BenchKit は概ね以下の論理構成を持つ。
170170

171-
### 6.1 `programs/*`
171+
### 6.1 アプリ実装層 / Application Implementation Layer
172172

173173
アプリごとの実装層である。
174174
各アプリは原則として以下を持つ。
@@ -190,7 +190,7 @@ Each application normally contains:
190190

191191
This layer defines application-specific behavior such as source acquisition, build, execution, and FOM extraction.
192192

193-
### 6.2 `scripts/*`
193+
### 6.2 共通実行基盤層 / Shared Execution Foundation
194194

195195
BenchKit の共通実行基盤である。
196196
ここでは主に以下を担う。
@@ -214,7 +214,7 @@ It mainly provides:
214214

215215
Common shell functions such as those in `bk_functions.sh` are central to absorbing repeated patterns while preserving the shell-first approach.
216216

217-
### 6.3 `config/*`
217+
### 6.3 system・queue 定義層 / System and Queue Definition Layer
218218

219219
BenchKit の system / queue 定義層である。
220220

@@ -236,7 +236,7 @@ Main roles:
236236

237237
`system.csv` is the source of truth for items such as system name, mode, runner tag, queue, and queue_group.
238238

239-
### 6.4 `result_server/*`
239+
### 6.4 ポータル層 / Portal Layer
240240

241241
BenchKit のポータル層である。
242242

@@ -487,10 +487,10 @@ Users should ideally be able to use BenchKit to:
487487

488488
本仕様は以下と整合する。
489489

490-
- [CX_FRAMEWORK.md](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md)
491-
- [CX_PLATFORM.md](C:/Users/yoshi/benchkit/docs/cx/CX_PLATFORM.md)
490+
- [CX_FRAMEWORK.md](./CX_FRAMEWORK.md)
491+
- [CX_PLATFORM.md](./CX_PLATFORM.md)
492492

493493
This specification is aligned with:
494494

495-
- [CX_FRAMEWORK.md](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md)
496-
- [CX_PLATFORM.md](C:/Users/yoshi/benchkit/docs/cx/CX_PLATFORM.md)
495+
- [CX_FRAMEWORK.md](./CX_FRAMEWORK.md)
496+
- [CX_PLATFORM.md](./CX_PLATFORM.md)

docs/cx/CX_FRAMEWORK.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,16 +53,16 @@ It is a higher-level framework that organizes the roles of platforms, tools, ser
5353

5454
下位には、少なくとも以下の仕様がぶら下がる。
5555

56-
- [`CX_PLATFORM.md`](C:/Users/yoshi/benchkit/docs/cx/CX_PLATFORM.md): CX フレームワークを実装する全体システムの仕様
57-
- [`BENCHKIT_SPEC.md`](C:/Users/yoshi/benchkit/docs/cx/BENCHKIT_SPEC.md): BenchKit の責務・構成・接続点の仕様
56+
- [`CX_PLATFORM.md`](./CX_PLATFORM.md): CX フレームワークを実装する全体システムの仕様
57+
- [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md): BenchKit の責務・構成・接続点の仕様
5858

5959
This document is the top-level conceptual specification for CX as a whole.
6060
It defines what should run continuously, and does not specify implementation details of individual software components or services.
6161

6262
At least the following lower-level specifications are expected beneath it:
6363

64-
- [`CX_PLATFORM.md`](C:/Users/yoshi/benchkit/docs/cx/CX_PLATFORM.md): the specification of the overall system implementing the CX Framework
65-
- [`BENCHKIT_SPEC.md`](C:/Users/yoshi/benchkit/docs/cx/BENCHKIT_SPEC.md): the specification of BenchKit responsibilities, structure, and integration points
64+
- [`CX_PLATFORM.md`](./CX_PLATFORM.md): the specification of the overall system implementing the CX Framework
65+
- [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md): the specification of BenchKit responsibilities, structure, and integration points
6666

6767
## 2. 適用範囲 / Scope
6868

docs/cx/CX_PLATFORM.md

Lines changed: 16 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If any discrepancy exists, the Japanese version takes precedence.
1111

1212
## 読み方のルール / Reading Conventions
1313

14-
本書では、[`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) の読み方のルールに従う。
14+
本書では、[`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) の読み方のルールに従う。
1515
特に、本書では以下を区別して読むことが重要である。
1616

1717
- 必須要件:
@@ -21,7 +21,7 @@ If any discrepancy exists, the Japanese version takes precedence.
2121
- 将来拡張:
2222
申請、承認、自動 PR、AI 連携など、将来の拡張方向。
2323

24-
This document follows the reading conventions defined in [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md).
24+
This document follows the reading conventions defined in [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md).
2525
In particular, it is important here to distinguish:
2626

2727
- mandatory requirements:
@@ -44,17 +44,17 @@ It integrates software components, external tools, external services, compute sy
4444

4545
## 1.1 文書の位置づけ / Position of This Document
4646

47-
本書は、[`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) を実装する全体システムとしての CX 基盤を定義する。
47+
本書は、[`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) を実装する全体システムとしての CX 基盤を定義する。
4848
本書は、構成要素、責務境界、接続要件を定義し、個別ソフトウェアの詳細仕様は下位仕様へ委ねる。
4949

50-
特に、BenchKit に関する詳細は [`BENCHKIT_SPEC.md`](C:/Users/yoshi/benchkit/docs/cx/BENCHKIT_SPEC.md) に委ねる。
51-
主要用語は [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md) の用語集に従う。
50+
特に、BenchKit に関する詳細は [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md) に委ねる。
51+
主要用語は [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md) の用語集に従う。
5252

53-
This document defines the CX Platform as the overall system that implements [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md).
53+
This document defines the CX Platform as the overall system that implements [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md).
5454
It defines components, responsibility boundaries, and connection requirements, while delegating software-specific details to lower-level specifications.
5555

56-
In particular, BenchKit-specific details are delegated to [`BENCHKIT_SPEC.md`](C:/Users/yoshi/benchkit/docs/cx/BENCHKIT_SPEC.md).
57-
Core terminology follows the glossary in [`CX_FRAMEWORK.md`](C:/Users/yoshi/benchkit/docs/cx/CX_FRAMEWORK.md).
56+
In particular, BenchKit-specific details are delegated to [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md).
57+
Core terminology follows the glossary in [`CX_FRAMEWORK.md`](./CX_FRAMEWORK.md).
5858

5959
## 2. 適用範囲 / Scope
6060

@@ -81,46 +81,24 @@ The CX Platform includes:
8181
## 3. BenchKit の位置づけ / Position of BenchKit
8282

8383
BenchKit は CX基盤を構成する中核ソフトウェアの1つである。
84-
85-
BenchKit は主に以下を担う。
86-
87-
- ベンチマーク定義と実行オーケストレーション
88-
- CI/CD を用いたジョブ生成
89-
- 結果の標準化
90-
- 結果および推定結果の表示
91-
- 推定・最適化・申請ワークフローへの接続点
84+
BenchKit は主として、CX 基盤におけるベンチマーク実行、結果正規化、結果表示、および関連ワークフローへの接続点を担う。
85+
BenchKit の詳細な責務、構成、データモデル、接続条件は [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md) に委ねる。
9286

9387
BenchKit is one of the core software components of the CX Platform.
94-
95-
BenchKit is primarily responsible for:
96-
97-
- benchmark definition and execution orchestration
98-
- CI/CD-driven job generation
99-
- result normalization
100-
- presentation of benchmark and estimation results
101-
- integration points for estimation, optimization, and request workflows
88+
BenchKit is primarily responsible for benchmark execution, result normalization, result presentation, and integration points for related workflows within the CX Platform.
89+
Detailed responsibilities, structure, data models, and integration conditions are delegated to [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md).
10290

10391
## 4. CX基盤の構成要素 / Platform Components
10492

10593
### 4.1 内部中核コンポーネント / Core Internal Components
10694

10795
#### BenchKit
10896

109-
BenchKit はベンチマーク実行と結果管理の中核基盤である。
110-
111-
主な構成:
112-
- `programs/*`
113-
- `scripts/*`
114-
- `config/*`
115-
- `result_server/*`
116-
117-
BenchKit is the core platform for benchmark execution and result management.
97+
BenchKit は CX 基盤における中核ソフトウェアであり、詳細は [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md) に委ねる。
98+
本書では、BenchKit を CX 基盤の主要構成要素として位置づけるにとどめる。
11899

119-
Main parts:
120-
- `programs/*`
121-
- `scripts/*`
122-
- `config/*`
123-
- `result_server/*`
100+
BenchKit is a core software component within the CX Platform, and its details are delegated to [`BENCHKIT_SPEC.md`](./BENCHKIT_SPEC.md).
101+
This document only positions BenchKit as one of the major components of the CX Platform.
124102

125103
#### 結果ポータル / Result Portal
126104

0 commit comments

Comments
 (0)