create-specment 0.2.2 → 0.2.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/commands/create.d.ts.map +1 -1
- package/bin/commands/create.js.map +1 -1
- package/bin/constants/languages.d.ts +1 -1
- package/bin/constants/languages.d.ts.map +1 -1
- package/bin/constants/languages.js +3 -3
- package/bin/core/interactive-setup.d.ts.map +1 -1
- package/bin/core/interactive-setup.js +20 -18
- package/bin/core/interactive-setup.js.map +1 -1
- package/bin/core/interactive-setup.test.js +11 -11
- package/bin/core/interactive-setup.test.js.map +1 -1
- package/bin/core/project-generator.d.ts.map +1 -1
- package/bin/core/project-generator.js +5 -10
- package/bin/core/project-generator.js.map +1 -1
- package/bin/features/index.js +12 -12
- package/bin/generators/docusaurus-config.js +48 -48
- package/bin/generators/docusaurus-config.js.map +1 -1
- package/bin/generators/package-json.js +14 -14
- package/bin/generators/package-json.js.map +1 -1
- package/bin/generators/template-files.d.ts.map +1 -1
- package/bin/generators/template-files.js +18 -15
- package/bin/generators/template-files.js.map +1 -1
- package/bin/index.d.ts.map +1 -1
- package/bin/index.js.map +1 -1
- package/bin/plugins/i18n-integration.d.ts.map +1 -1
- package/bin/plugins/i18n-integration.js +61 -60
- package/bin/plugins/i18n-integration.js.map +1 -1
- package/bin/plugins/plantuml-integration.d.ts.map +1 -1
- package/bin/plugins/plantuml-integration.js +12 -11
- package/bin/plugins/plantuml-integration.js.map +1 -1
- package/bin/plugins/redoc-integration.d.ts.map +1 -1
- package/bin/plugins/redoc-integration.js +13 -12
- package/bin/plugins/redoc-integration.js.map +1 -1
- package/bin/plugins/search-integration.d.ts.map +1 -1
- package/bin/plugins/search-integration.js +15 -11
- package/bin/plugins/search-integration.js.map +1 -1
- package/bin/templates/index.js +15 -15
- package/bin/templates/index.js.map +1 -1
- package/bin/templates/template-definitions.d.ts.map +1 -1
- package/bin/templates/template-definitions.js +228 -7
- package/bin/templates/template-definitions.js.map +1 -1
- package/bin/tests/integration.test.js +26 -24
- package/bin/tests/integration.test.js.map +1 -1
- package/bin/utils/config-merger.d.ts +1 -1
- package/bin/utils/config-merger.d.ts.map +1 -1
- package/bin/utils/config-merger.js +12 -14
- package/bin/utils/config-merger.js.map +1 -1
- package/bin/utils/install.d.ts.map +1 -1
- package/bin/utils/install.js +28 -4
- package/bin/utils/install.js.map +1 -1
- package/bin/utils/message-formatter.d.ts.map +1 -1
- package/bin/utils/message-formatter.js +1 -0
- package/bin/utils/message-formatter.js.map +1 -1
- package/bin/utils/template-processor.d.ts.map +1 -1
- package/bin/utils/template-processor.js +2 -2
- package/bin/utils/template-processor.js.map +1 -1
- package/bin/utils/version.js +3 -3
- package/bin/utils/version.js.map +1 -1
- package/package.json +3 -4
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
// biome-ignore lint/complexity/noStaticOnlyClass: 統合クラスは静的メソッドを持つユーティリティ名前空間として設計されており、より良い組織化のため
|
|
1
2
|
export class RedocIntegration {
|
|
2
3
|
static getDefaultConfig() {
|
|
3
4
|
return {
|
|
@@ -5,13 +6,13 @@ export class RedocIntegration {
|
|
|
5
6
|
{
|
|
6
7
|
spec: 'static/openapi.yaml',
|
|
7
8
|
route: '/api/',
|
|
8
|
-
id: 'main-api'
|
|
9
|
-
}
|
|
9
|
+
id: 'main-api',
|
|
10
|
+
},
|
|
10
11
|
],
|
|
11
12
|
theme: {
|
|
12
13
|
primaryColor: '#1976d2',
|
|
13
|
-
primaryColorDark: '#1565c0'
|
|
14
|
-
}
|
|
14
|
+
primaryColorDark: '#1565c0',
|
|
15
|
+
},
|
|
15
16
|
};
|
|
16
17
|
}
|
|
17
18
|
static generateDocusaurusConfig(feature) {
|
|
@@ -22,15 +23,15 @@ export class RedocIntegration {
|
|
|
22
23
|
'redocusaurus',
|
|
23
24
|
{
|
|
24
25
|
specs: config.specs || RedocIntegration.getDefaultConfig().specs,
|
|
25
|
-
theme: config.theme || RedocIntegration.getDefaultConfig().theme
|
|
26
|
-
}
|
|
27
|
-
]
|
|
28
|
-
]
|
|
26
|
+
theme: config.theme || RedocIntegration.getDefaultConfig().theme,
|
|
27
|
+
},
|
|
28
|
+
],
|
|
29
|
+
],
|
|
29
30
|
};
|
|
30
31
|
}
|
|
31
32
|
static getDependencies() {
|
|
32
33
|
return {
|
|
33
|
-
|
|
34
|
+
redocusaurus: '^2.0.0',
|
|
34
35
|
};
|
|
35
36
|
}
|
|
36
37
|
static generateSampleOpenAPISpec() {
|
|
@@ -349,20 +350,20 @@ curl -X POST "https://api.example.com/v1/users" \\
|
|
|
349
350
|
if (!config.specs || config.specs.length === 0) {
|
|
350
351
|
return {
|
|
351
352
|
valid: false,
|
|
352
|
-
message: 'At least one OpenAPI spec must be configured'
|
|
353
|
+
message: 'At least one OpenAPI spec must be configured',
|
|
353
354
|
};
|
|
354
355
|
}
|
|
355
356
|
for (const spec of config.specs) {
|
|
356
357
|
if (!spec.spec || !spec.route) {
|
|
357
358
|
return {
|
|
358
359
|
valid: false,
|
|
359
|
-
message: 'Each spec must have both "spec" and "route" properties'
|
|
360
|
+
message: 'Each spec must have both "spec" and "route" properties',
|
|
360
361
|
};
|
|
361
362
|
}
|
|
362
363
|
if (!spec.route.startsWith('/')) {
|
|
363
364
|
return {
|
|
364
365
|
valid: false,
|
|
365
|
-
message: 'Route must start with "/"'
|
|
366
|
+
message: 'Route must start with "/"',
|
|
366
367
|
};
|
|
367
368
|
}
|
|
368
369
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redoc-integration.js","sourceRoot":"","sources":["../../src/plugins/redoc-integration.ts"],"names":[],"mappings":"AAgBA,MAAM,OAAO,gBAAgB;IAC3B,MAAM,CAAC,gBAAgB;QACrB,OAAO;YACL,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,KAAK,EAAE,OAAO;oBACd,EAAE,EAAE,UAAU;iBACf;aACF;YACD,KAAK,EAAE;gBACL,YAAY,EAAE,SAAS;gBACvB,gBAAgB,EAAE,SAAS;aAC5B;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB,CAAC,OAAyB;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,YAAY,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC;QAEnF,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,cAAc;oBACd;wBACE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,KAAK;wBAChE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,KAAK;qBACjE;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe;QACpB,OAAO;YACL,
|
|
1
|
+
{"version":3,"file":"redoc-integration.js","sourceRoot":"","sources":["../../src/plugins/redoc-integration.ts"],"names":[],"mappings":"AAgBA,kGAAkG;AAClG,MAAM,OAAO,gBAAgB;IAC3B,MAAM,CAAC,gBAAgB;QACrB,OAAO;YACL,KAAK,EAAE;gBACL;oBACE,IAAI,EAAE,qBAAqB;oBAC3B,KAAK,EAAE,OAAO;oBACd,EAAE,EAAE,UAAU;iBACf;aACF;YACD,KAAK,EAAE;gBACL,YAAY,EAAE,SAAS;gBACvB,gBAAgB,EAAE,SAAS;aAC5B;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB,CAAC,OAAyB;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,YAAY,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC;QAEnF,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,cAAc;oBACd;wBACE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,KAAK;wBAChE,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,gBAAgB,CAAC,gBAAgB,EAAE,CAAC,KAAK;qBACjE;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe;QACpB,OAAO;YACL,YAAY,EAAE,QAAQ;SACvB,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,yBAAyB;QAC9B,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwPV,CAAC;IACA,CAAC;IAED,MAAM,CAAC,2BAA2B;QAChC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0DV,CAAC;IACA,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAmB;QACvC,IAAI,CAAC,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC/C,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,8CAA8C;aACxD,CAAC;QACJ,CAAC;QAED,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YAChC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,OAAO;oBACL,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,wDAAwD;iBAClE,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAChC,OAAO;oBACL,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,2BAA2B;iBACrC,CAAC;YACJ,CAAC;QACH,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;CACF"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search-integration.d.ts","sourceRoot":"","sources":["../../src/plugins/search-integration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAG1D,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAC3C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC;
|
|
1
|
+
{"version":3,"file":"search-integration.d.ts","sourceRoot":"","sources":["../../src/plugins/search-integration.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAG1D,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC,gCAAgC,CAAC,EAAE,OAAO,CAAC;IAC3C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,4BAA4B,CAAC,EAAE,MAAM,CAAC;CACvC;AAGD,qBAAa,iBAAiB;IAC5B,MAAM,CAAC,gBAAgB,IAAI,YAAY;IAWvC,MAAM,CAAC,wBAAwB,CAAC,OAAO,EAAE,gBAAgB,GAAG,GAAG;IA0B/D,MAAM,CAAC,eAAe,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC;IAMhD,MAAM,CAAC,2BAA2B,IAAI,MAAM;IAsG5C,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,YAAY,GAAG;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE;CA+BlF"}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { LANG } from '../constants/languages.js';
|
|
2
|
+
// biome-ignore lint/complexity/noStaticOnlyClass: 統合クラスは静的メソッドを持つユーティリティ名前空間として設計されており、より良い組織化のため
|
|
2
3
|
export class SearchIntegration {
|
|
3
4
|
static getDefaultConfig() {
|
|
4
5
|
return {
|
|
@@ -7,7 +8,7 @@ export class SearchIntegration {
|
|
|
7
8
|
removeDefaultStopWordFilter: false,
|
|
8
9
|
highlightSearchTermsOnTargetPage: true,
|
|
9
10
|
searchResultLimits: 8,
|
|
10
|
-
searchResultContextMaxLength: 50
|
|
11
|
+
searchResultContextMaxLength: 50,
|
|
11
12
|
};
|
|
12
13
|
}
|
|
13
14
|
static generateDocusaurusConfig(feature) {
|
|
@@ -28,15 +29,15 @@ export class SearchIntegration {
|
|
|
28
29
|
indexBlog: true,
|
|
29
30
|
indexPages: false,
|
|
30
31
|
docsRouteBasePath: '/docs',
|
|
31
|
-
blogRouteBasePath: '/blog'
|
|
32
|
-
}
|
|
33
|
-
]
|
|
34
|
-
]
|
|
32
|
+
blogRouteBasePath: '/blog',
|
|
33
|
+
},
|
|
34
|
+
],
|
|
35
|
+
],
|
|
35
36
|
};
|
|
36
37
|
}
|
|
37
38
|
static getDependencies() {
|
|
38
39
|
return {
|
|
39
|
-
'@easyops-cn/docusaurus-search-local': '^0.52.2'
|
|
40
|
+
'@easyops-cn/docusaurus-search-local': '^0.52.2',
|
|
40
41
|
};
|
|
41
42
|
}
|
|
42
43
|
static generateSearchDocumentation() {
|
|
@@ -144,19 +145,22 @@ export class SearchIntegration {
|
|
|
144
145
|
if (config.language && !Array.isArray(config.language)) {
|
|
145
146
|
return {
|
|
146
147
|
valid: false,
|
|
147
|
-
message: 'Search language must be an array'
|
|
148
|
+
message: 'Search language must be an array',
|
|
148
149
|
};
|
|
149
150
|
}
|
|
150
|
-
if (config.searchResultLimits &&
|
|
151
|
+
if (config.searchResultLimits &&
|
|
152
|
+
(typeof config.searchResultLimits !== 'number' || config.searchResultLimits <= 0)) {
|
|
151
153
|
return {
|
|
152
154
|
valid: false,
|
|
153
|
-
message: 'Search result limits must be a positive number'
|
|
155
|
+
message: 'Search result limits must be a positive number',
|
|
154
156
|
};
|
|
155
157
|
}
|
|
156
|
-
if (config.searchResultContextMaxLength &&
|
|
158
|
+
if (config.searchResultContextMaxLength &&
|
|
159
|
+
(typeof config.searchResultContextMaxLength !== 'number' ||
|
|
160
|
+
config.searchResultContextMaxLength <= 0)) {
|
|
157
161
|
return {
|
|
158
162
|
valid: false,
|
|
159
|
-
message: 'Search result context max length must be a positive number'
|
|
163
|
+
message: 'Search result context max length must be a positive number',
|
|
160
164
|
};
|
|
161
165
|
}
|
|
162
166
|
return { valid: true };
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"search-integration.js","sourceRoot":"","sources":["../../src/plugins/search-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AAWjD,MAAM,OAAO,iBAAiB;IAC5B,MAAM,CAAC,gBAAgB;QACrB,OAAO;YACL,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;YAC9B,2BAA2B,EAAE,KAAK;YAClC,gCAAgC,EAAE,IAAI;YACtC,kBAAkB,EAAE,CAAC;YACrB,4BAA4B,EAAE,EAAE;SACjC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB,CAAC,OAAyB;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,IAAI,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;QAE9E,OAAO;YACL,MAAM,EAAE;gBACN;oBACE,qCAAqC;oBACrC;wBACE,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;wBAC/D,gCAAgC,EAAE,MAAM,CAAC,gCAAgC;wBACzE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;wBAC7C,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;wBACjE,YAAY;wBACZ,SAAS,EAAE,IAAI;wBACf,SAAS,EAAE,IAAI;wBACf,UAAU,EAAE,KAAK;wBACjB,iBAAiB,EAAE,OAAO;wBAC1B,iBAAiB,EAAE,OAAO;qBAC3B;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe;QACpB,OAAO;YACL,qCAAqC,EAAE,SAAS;SACjD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,2BAA2B;QAChC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkGV,CAAC;IACA,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAoB;QACxC,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvD,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,kCAAkC;aAC5C,CAAC;QACJ,CAAC;QAED,
|
|
1
|
+
{"version":3,"file":"search-integration.js","sourceRoot":"","sources":["../../src/plugins/search-integration.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,2BAA2B,CAAC;AAWjD,kGAAkG;AAClG,MAAM,OAAO,iBAAiB;IAC5B,MAAM,CAAC,gBAAgB;QACrB,OAAO;YACL,MAAM,EAAE,KAAK;YACb,QAAQ,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;YAC9B,2BAA2B,EAAE,KAAK;YAClC,gCAAgC,EAAE,IAAI;YACtC,kBAAkB,EAAE,CAAC;YACrB,4BAA4B,EAAE,EAAE;SACjC,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,wBAAwB,CAAC,OAAyB;QACvD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,MAAM,IAAI,iBAAiB,CAAC,gBAAgB,EAAE,CAAC;QAE9E,OAAO;YACL,MAAM,EAAE;gBACN;oBACE,qCAAqC;oBACrC;wBACE,MAAM,EAAE,MAAM,CAAC,MAAM;wBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;wBACzB,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;wBAC/D,gCAAgC,EAAE,MAAM,CAAC,gCAAgC;wBACzE,kBAAkB,EAAE,MAAM,CAAC,kBAAkB;wBAC7C,4BAA4B,EAAE,MAAM,CAAC,4BAA4B;wBACjE,YAAY;wBACZ,SAAS,EAAE,IAAI;wBACf,SAAS,EAAE,IAAI;wBACf,UAAU,EAAE,KAAK;wBACjB,iBAAiB,EAAE,OAAO;wBAC1B,iBAAiB,EAAE,OAAO;qBAC3B;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,eAAe;QACpB,OAAO;YACL,qCAAqC,EAAE,SAAS;SACjD,CAAC;IACJ,CAAC;IAED,MAAM,CAAC,2BAA2B;QAChC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkGV,CAAC;IACA,CAAC;IAED,MAAM,CAAC,cAAc,CAAC,MAAoB;QACxC,IAAI,MAAM,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;YACvD,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,kCAAkC;aAC5C,CAAC;QACJ,CAAC;QAED,IACE,MAAM,CAAC,kBAAkB;YACzB,CAAC,OAAO,MAAM,CAAC,kBAAkB,KAAK,QAAQ,IAAI,MAAM,CAAC,kBAAkB,IAAI,CAAC,CAAC,EACjF,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,gDAAgD;aAC1D,CAAC;QACJ,CAAC;QAED,IACE,MAAM,CAAC,4BAA4B;YACnC,CAAC,OAAO,MAAM,CAAC,4BAA4B,KAAK,QAAQ;gBACtD,MAAM,CAAC,4BAA4B,IAAI,CAAC,CAAC,EAC3C,CAAC;YACD,OAAO;gBACL,KAAK,EAAE,KAAK;gBACZ,OAAO,EAAE,4DAA4D;aACtE,CAAC;QACJ,CAAC;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IACzB,CAAC;CACF"}
|
package/bin/templates/index.js
CHANGED
|
@@ -4,57 +4,57 @@ const TEMPLATE_DATA = [
|
|
|
4
4
|
name: 'classic-spec',
|
|
5
5
|
displayName: {
|
|
6
6
|
[LANG.EN.code]: 'Classic Specification',
|
|
7
|
-
[LANG.JP.code]: '基本仕様書'
|
|
7
|
+
[LANG.JP.code]: '基本仕様書',
|
|
8
8
|
},
|
|
9
9
|
description: {
|
|
10
10
|
[LANG.EN.code]: 'General-purpose specification documentation template',
|
|
11
|
-
[LANG.JP.code]: '汎用的な仕様書ドキュメントテンプレート'
|
|
11
|
+
[LANG.JP.code]: '汎用的な仕様書ドキュメントテンプレート',
|
|
12
12
|
},
|
|
13
|
-
features: ['search', 'plantuml']
|
|
13
|
+
features: ['search', 'plantuml'],
|
|
14
14
|
},
|
|
15
15
|
{
|
|
16
16
|
name: 'api-spec',
|
|
17
17
|
displayName: {
|
|
18
18
|
[LANG.EN.code]: 'API Specification',
|
|
19
|
-
[LANG.JP.code]: 'API仕様書'
|
|
19
|
+
[LANG.JP.code]: 'API仕様書',
|
|
20
20
|
},
|
|
21
21
|
description: {
|
|
22
22
|
[LANG.EN.code]: 'Template for API specification and documentation',
|
|
23
|
-
[LANG.JP.code]: 'API仕様書・ドキュメント用テンプレート'
|
|
23
|
+
[LANG.JP.code]: 'API仕様書・ドキュメント用テンプレート',
|
|
24
24
|
},
|
|
25
|
-
features: ['search', 'plantuml', 'redoc']
|
|
25
|
+
features: ['search', 'plantuml', 'redoc'],
|
|
26
26
|
},
|
|
27
27
|
{
|
|
28
28
|
name: 'technical-spec',
|
|
29
29
|
displayName: {
|
|
30
30
|
[LANG.EN.code]: 'Technical Specification',
|
|
31
|
-
[LANG.JP.code]: '技術仕様書'
|
|
31
|
+
[LANG.JP.code]: '技術仕様書',
|
|
32
32
|
},
|
|
33
33
|
description: {
|
|
34
34
|
[LANG.EN.code]: 'Template for technical specification and architecture',
|
|
35
|
-
[LANG.JP.code]: '技術仕様書・アーキテクチャ用テンプレート'
|
|
35
|
+
[LANG.JP.code]: '技術仕様書・アーキテクチャ用テンプレート',
|
|
36
36
|
},
|
|
37
|
-
features: ['search', 'plantuml']
|
|
37
|
+
features: ['search', 'plantuml'],
|
|
38
38
|
},
|
|
39
39
|
{
|
|
40
40
|
name: 'enterprise-spec',
|
|
41
41
|
displayName: {
|
|
42
42
|
[LANG.EN.code]: 'Enterprise Specification',
|
|
43
|
-
[LANG.JP.code]: '企業向け仕様書'
|
|
43
|
+
[LANG.JP.code]: '企業向け仕様書',
|
|
44
44
|
},
|
|
45
45
|
description: {
|
|
46
46
|
[LANG.EN.code]: 'Template for enterprise specification and documentation',
|
|
47
|
-
[LANG.JP.code]: '企業向け仕様書・ドキュメント用テンプレート'
|
|
47
|
+
[LANG.JP.code]: '企業向け仕様書・ドキュメント用テンプレート',
|
|
48
48
|
},
|
|
49
|
-
features: ['search', 'plantuml', 'redoc', 'i18n']
|
|
50
|
-
}
|
|
49
|
+
features: ['search', 'plantuml', 'redoc', 'i18n'],
|
|
50
|
+
},
|
|
51
51
|
];
|
|
52
52
|
export function getAvailableTemplates(language = LANG.EN.code) {
|
|
53
|
-
return TEMPLATE_DATA.map(template => ({
|
|
53
|
+
return TEMPLATE_DATA.map((template) => ({
|
|
54
54
|
name: template.name,
|
|
55
55
|
displayName: template.displayName[language],
|
|
56
56
|
description: template.description[language],
|
|
57
|
-
features: template.features
|
|
57
|
+
features: template.features,
|
|
58
58
|
}));
|
|
59
59
|
}
|
|
60
60
|
//# sourceMappingURL=index.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAiB,MAAM,2BAA2B,CAAC;AAehE,MAAM,aAAa,GAAmB;IACpC;QACE,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,uBAAuB;YACvC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO;SACxB;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,sDAAsD;YACtE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,qBAAqB;SACtC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;KACjC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,mBAAmB;YACnC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ;SACzB;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,kDAAkD;YAClE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,sBAAsB;SACvC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC;KAC1C;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,yBAAyB;YACzC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO;SACxB;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,uDAAuD;YACvE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,sBAAsB;SACvC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;KACjC;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,0BAA0B;YAC1C,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,SAAS;SAC1B;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,yDAAyD;YACzE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,uBAAuB;SACxC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC;KAClD;CACF,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,WAAqB,IAAI,CAAC,EAAE,CAAC,IAAI;IACrE,OAAO,aAAa,CAAC,GAAG,CAAC,QAAQ,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/templates/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAiB,MAAM,2BAA2B,CAAC;AAehE,MAAM,aAAa,GAAmB;IACpC;QACE,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,uBAAuB;YACvC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO;SACxB;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,sDAAsD;YACtE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,qBAAqB;SACtC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;KACjC;IACD;QACE,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,mBAAmB;YACnC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ;SACzB;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,kDAAkD;YAClE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,sBAAsB;SACvC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,CAAC;KAC1C;IACD;QACE,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,yBAAyB;YACzC,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,OAAO;SACxB;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,uDAAuD;YACvE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,sBAAsB;SACvC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,CAAC;KACjC;IACD;QACE,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,0BAA0B;YAC1C,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,SAAS;SAC1B;QACD,WAAW,EAAE;YACX,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,yDAAyD;YACzE,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,uBAAuB;SACxC;QACD,QAAQ,EAAE,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,CAAC;KAClD;CACF,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,WAAqB,IAAI,CAAC,EAAE,CAAC,IAAI;IACrE,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QACtC,IAAI,EAAE,QAAQ,CAAC,IAA4B;QAC3C,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC;QAC3C,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC,QAAQ,CAAC;QAC3C,QAAQ,EAAE,QAAQ,CAAC,QAAQ;KAC5B,CAAC,CAAC,CAAC;AACN,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"template-definitions.d.ts","sourceRoot":"","sources":["../../src/templates/template-definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,
|
|
1
|
+
{"version":3,"file":"template-definitions.d.ts","sourceRoot":"","sources":["../../src/templates/template-definitions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAExD,eAAO,MAAM,mBAAmB,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CA8f9D,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAEtF;AAED,wBAAgB,mBAAmB,IAAI,MAAM,EAAE,CAE9C;AAED,wBAAgB,uBAAuB,IAAI,KAAK,CAAC;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC,CAMD"}
|
|
@@ -10,7 +10,7 @@ export const templateDefinitions = {
|
|
|
10
10
|
},
|
|
11
11
|
defaultFeatures: ['search'],
|
|
12
12
|
directoryStructure: {
|
|
13
|
-
docs: ['
|
|
13
|
+
docs: ['tutorial-basics', 'tutorial-extras'],
|
|
14
14
|
static: ['img'],
|
|
15
15
|
src: ['css', 'components'],
|
|
16
16
|
},
|
|
@@ -76,22 +76,22 @@ sidebar_position: 1
|
|
|
76
76
|
### SWOT分析
|
|
77
77
|
|
|
78
78
|
#### Strengths (強み)
|
|
79
|
-
-
|
|
79
|
+
-
|
|
80
80
|
|
|
81
81
|
#### Weaknesses (弱み)
|
|
82
|
-
-
|
|
82
|
+
-
|
|
83
83
|
|
|
84
84
|
#### Opportunities (機会)
|
|
85
|
-
-
|
|
85
|
+
-
|
|
86
86
|
|
|
87
87
|
#### Threats (脅威)
|
|
88
|
-
-
|
|
88
|
+
-
|
|
89
89
|
`,
|
|
90
90
|
template: true,
|
|
91
91
|
},
|
|
92
92
|
],
|
|
93
93
|
},
|
|
94
|
-
|
|
94
|
+
requirements: {
|
|
95
95
|
name: 'requirements',
|
|
96
96
|
displayName: 'Requirements Specification',
|
|
97
97
|
description: '要件定義書テンプレート。機能要件・非機能要件を体系的に整理できます。',
|
|
@@ -274,6 +274,227 @@ CoreService --> BusinessLogic
|
|
|
274
274
|
1. **コーディング規約**: TypeScript/ESLintルールに従う
|
|
275
275
|
2. **テスト**: 単体テスト・統合テストを必須とする
|
|
276
276
|
3. **ドキュメント**: JSDocによるAPI仕様書を作成
|
|
277
|
+
`,
|
|
278
|
+
template: true,
|
|
279
|
+
},
|
|
280
|
+
],
|
|
281
|
+
},
|
|
282
|
+
'api-spec': {
|
|
283
|
+
name: 'api-spec',
|
|
284
|
+
displayName: 'API Specification',
|
|
285
|
+
description: 'API仕様書テンプレート。RESTful APIの詳細な仕様を記述できます。',
|
|
286
|
+
docusaurusConfig: {
|
|
287
|
+
title: 'API Specification Documentation',
|
|
288
|
+
tagline: 'API Specification Documentation',
|
|
289
|
+
presets: [['classic', { blog: false }]],
|
|
290
|
+
},
|
|
291
|
+
defaultFeatures: ['redoc', 'search'],
|
|
292
|
+
directoryStructure: {
|
|
293
|
+
docs: ['api', 'authentication', 'endpoints'],
|
|
294
|
+
static: ['img', 'api-specs'],
|
|
295
|
+
},
|
|
296
|
+
sampleContent: [
|
|
297
|
+
{
|
|
298
|
+
path: 'docs/api/intro.md',
|
|
299
|
+
content: `---
|
|
300
|
+
sidebar_position: 1
|
|
301
|
+
---
|
|
302
|
+
|
|
303
|
+
# API概要
|
|
304
|
+
|
|
305
|
+
このセクションでは、APIの全体的な仕様について説明します。
|
|
306
|
+
|
|
307
|
+
## API設計原則
|
|
308
|
+
|
|
309
|
+
1. **RESTful設計**: REST原則に従ったAPI設計
|
|
310
|
+
2. **一貫性**: 統一されたレスポンス形式
|
|
311
|
+
3. **セキュリティ**: 適切な認証・認可機能
|
|
312
|
+
|
|
313
|
+
## ベースURL
|
|
314
|
+
|
|
315
|
+
\`\`\`
|
|
316
|
+
https://api.example.com/v1
|
|
317
|
+
\`\`\`
|
|
318
|
+
|
|
319
|
+
## 認証
|
|
320
|
+
|
|
321
|
+
APIへのアクセスには認証が必要です。
|
|
322
|
+
|
|
323
|
+
### Bearer Token認証
|
|
324
|
+
|
|
325
|
+
\`\`\`http
|
|
326
|
+
Authorization: Bearer <your-token>
|
|
327
|
+
\`\`\`
|
|
328
|
+
|
|
329
|
+
## レスポンス形式
|
|
330
|
+
|
|
331
|
+
すべてのAPIレスポンスは以下の形式に従います:
|
|
332
|
+
|
|
333
|
+
\`\`\`json
|
|
334
|
+
{
|
|
335
|
+
"success": true,
|
|
336
|
+
"data": {},
|
|
337
|
+
"message": "Success",
|
|
338
|
+
"timestamp": "2026-01-02T15:00:00Z"
|
|
339
|
+
}
|
|
340
|
+
\`\`\`
|
|
341
|
+
`,
|
|
342
|
+
template: true,
|
|
343
|
+
},
|
|
344
|
+
],
|
|
345
|
+
},
|
|
346
|
+
'technical-spec': {
|
|
347
|
+
name: 'technical-spec',
|
|
348
|
+
displayName: 'Technical Specification',
|
|
349
|
+
description: '技術仕様書テンプレート。システムの技術的な詳細を包括的に記述できます。',
|
|
350
|
+
docusaurusConfig: {
|
|
351
|
+
title: 'Technical Specification Documentation',
|
|
352
|
+
tagline: 'Technical Specification Documentation',
|
|
353
|
+
presets: [['classic', { blog: false }]],
|
|
354
|
+
},
|
|
355
|
+
defaultFeatures: ['plantuml', 'search'],
|
|
356
|
+
directoryStructure: {
|
|
357
|
+
docs: ['architecture', 'technology-stack', 'deployment'],
|
|
358
|
+
static: ['img', 'diagrams'],
|
|
359
|
+
},
|
|
360
|
+
sampleContent: [
|
|
361
|
+
{
|
|
362
|
+
path: 'docs/architecture/intro.md',
|
|
363
|
+
content: `---
|
|
364
|
+
sidebar_position: 1
|
|
365
|
+
---
|
|
366
|
+
|
|
367
|
+
# 技術アーキテクチャ
|
|
368
|
+
|
|
369
|
+
このセクションでは、システムの技術的なアーキテクチャについて詳細に説明します。
|
|
370
|
+
|
|
371
|
+
## システム構成
|
|
372
|
+
|
|
373
|
+
\`\`\`plantuml
|
|
374
|
+
@startuml
|
|
375
|
+
!theme plain
|
|
376
|
+
|
|
377
|
+
package "Frontend Layer" {
|
|
378
|
+
[React Application]
|
|
379
|
+
[Mobile App]
|
|
380
|
+
}
|
|
381
|
+
|
|
382
|
+
package "API Layer" {
|
|
383
|
+
[API Gateway]
|
|
384
|
+
[Load Balancer]
|
|
385
|
+
}
|
|
386
|
+
|
|
387
|
+
package "Application Layer" {
|
|
388
|
+
[Microservice A]
|
|
389
|
+
[Microservice B]
|
|
390
|
+
[Microservice C]
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
package "Data Layer" {
|
|
394
|
+
[PostgreSQL]
|
|
395
|
+
[Redis Cache]
|
|
396
|
+
[File Storage]
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
[React Application] --> [API Gateway]
|
|
400
|
+
[Mobile App] --> [API Gateway]
|
|
401
|
+
[API Gateway] --> [Load Balancer]
|
|
402
|
+
[Load Balancer] --> [Microservice A]
|
|
403
|
+
[Load Balancer] --> [Microservice B]
|
|
404
|
+
[Load Balancer] --> [Microservice C]
|
|
405
|
+
[Microservice A] --> [PostgreSQL]
|
|
406
|
+
[Microservice B] --> [Redis Cache]
|
|
407
|
+
[Microservice C] --> [File Storage]
|
|
408
|
+
|
|
409
|
+
@enduml
|
|
410
|
+
\`\`\`
|
|
411
|
+
|
|
412
|
+
## 技術スタック
|
|
413
|
+
|
|
414
|
+
### フロントエンド
|
|
415
|
+
- **Framework**: React 18.x
|
|
416
|
+
- **State Management**: Redux Toolkit
|
|
417
|
+
- **UI Library**: Material-UI
|
|
418
|
+
- **Build Tool**: Vite
|
|
419
|
+
|
|
420
|
+
### バックエンド
|
|
421
|
+
- **Runtime**: Node.js 20.x
|
|
422
|
+
- **Framework**: Express.js
|
|
423
|
+
- **Database**: PostgreSQL 15.x
|
|
424
|
+
- **Cache**: Redis 7.x
|
|
425
|
+
|
|
426
|
+
### インフラストラクチャ
|
|
427
|
+
- **Container**: Docker
|
|
428
|
+
- **Orchestration**: Kubernetes
|
|
429
|
+
- **Cloud Provider**: AWS
|
|
430
|
+
- **CI/CD**: GitHub Actions
|
|
431
|
+
`,
|
|
432
|
+
template: true,
|
|
433
|
+
},
|
|
434
|
+
],
|
|
435
|
+
},
|
|
436
|
+
'enterprise-spec': {
|
|
437
|
+
name: 'enterprise-spec',
|
|
438
|
+
displayName: 'Enterprise Specification',
|
|
439
|
+
description: '企業向け仕様書テンプレート。エンタープライズレベルの要件と仕様を記述できます。',
|
|
440
|
+
docusaurusConfig: {
|
|
441
|
+
title: 'Enterprise Specification Documentation',
|
|
442
|
+
tagline: 'Enterprise Specification Documentation',
|
|
443
|
+
presets: [['classic', { blog: false }]],
|
|
444
|
+
},
|
|
445
|
+
defaultFeatures: ['search', 'i18n'],
|
|
446
|
+
directoryStructure: {
|
|
447
|
+
docs: ['business-requirements', 'compliance', 'governance'],
|
|
448
|
+
static: ['img', 'documents'],
|
|
449
|
+
},
|
|
450
|
+
sampleContent: [
|
|
451
|
+
{
|
|
452
|
+
path: 'docs/business-requirements/intro.md',
|
|
453
|
+
content: `---
|
|
454
|
+
sidebar_position: 1
|
|
455
|
+
---
|
|
456
|
+
|
|
457
|
+
# ビジネス要件
|
|
458
|
+
|
|
459
|
+
このセクションでは、エンタープライズシステムのビジネス要件について説明します。
|
|
460
|
+
|
|
461
|
+
## ビジネス目標
|
|
462
|
+
|
|
463
|
+
### 主要目標
|
|
464
|
+
1. **業務効率化**: 既存業務プロセスの自動化により、30%の効率向上を実現
|
|
465
|
+
2. **コスト削減**: システム統合により、年間運用コストを20%削減
|
|
466
|
+
3. **顧客満足度向上**: レスポンス時間の短縮により、顧客満足度を向上
|
|
467
|
+
|
|
468
|
+
### 成功指標(KPI)
|
|
469
|
+
- **処理時間**: 平均処理時間を50%短縮
|
|
470
|
+
- **エラー率**: システムエラー率を1%以下に維持
|
|
471
|
+
- **可用性**: 99.9%以上のシステム稼働率
|
|
472
|
+
|
|
473
|
+
## ステークホルダー
|
|
474
|
+
|
|
475
|
+
### 内部ステークホルダー
|
|
476
|
+
- **経営陣**: 戦略的意思決定と予算承認
|
|
477
|
+
- **IT部門**: システム開発・運用・保守
|
|
478
|
+
- **業務部門**: 日常業務でのシステム利用
|
|
479
|
+
|
|
480
|
+
### 外部ステークホルダー
|
|
481
|
+
- **顧客**: サービス利用者
|
|
482
|
+
- **パートナー企業**: システム連携先
|
|
483
|
+
- **監査機関**: コンプライアンス監査
|
|
484
|
+
|
|
485
|
+
## コンプライアンス要件
|
|
486
|
+
|
|
487
|
+
### セキュリティ基準
|
|
488
|
+
- **ISO 27001**: 情報セキュリティマネジメントシステム
|
|
489
|
+
- **SOC 2**: セキュリティ・可用性・処理の完全性
|
|
490
|
+
|
|
491
|
+
### データ保護
|
|
492
|
+
- **GDPR**: EU一般データ保護規則への準拠
|
|
493
|
+
- **個人情報保護法**: 日本の個人情報保護法への準拠
|
|
494
|
+
|
|
495
|
+
### 業界標準
|
|
496
|
+
- **PCI DSS**: クレジットカード業界データセキュリティ基準
|
|
497
|
+
- **HIPAA**: 医療情報の取り扱い基準(該当する場合)
|
|
277
498
|
`,
|
|
278
499
|
template: true,
|
|
279
500
|
},
|
|
@@ -287,7 +508,7 @@ export function getAllTemplateNames() {
|
|
|
287
508
|
return Object.keys(templateDefinitions);
|
|
288
509
|
}
|
|
289
510
|
export function getTemplateDisplayNames() {
|
|
290
|
-
return Object.values(templateDefinitions).map(template => ({
|
|
511
|
+
return Object.values(templateDefinitions).map((template) => ({
|
|
291
512
|
name: template.name,
|
|
292
513
|
displayName: template.displayName,
|
|
293
514
|
description: template.description,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"template-definitions.js","sourceRoot":"","sources":["../../src/templates/template-definitions.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAmC;IACjE,cAAc,EAAE;QACd,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,mCAAmC;QAChD,gBAAgB,EAAE;YAChB,KAAK,EAAE,qCAAqC;YAC5C,OAAO,EAAE,qCAAqC;YAC9C,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;SAC5D;QACD,eAAe,EAAE,CAAC,QAAQ,CAAC;QAC3B,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,
|
|
1
|
+
{"version":3,"file":"template-definitions.js","sourceRoot":"","sources":["../../src/templates/template-definitions.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,mBAAmB,GAAmC;IACjE,cAAc,EAAE;QACd,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,uBAAuB;QACpC,WAAW,EAAE,mCAAmC;QAChD,gBAAgB,EAAE;YAChB,KAAK,EAAE,qCAAqC;YAC5C,OAAO,EAAE,qCAAqC;YAC9C,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;SAC5D;QACD,eAAe,EAAE,CAAC,QAAQ,CAAC;QAC3B,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,iBAAiB,EAAE,iBAAiB,CAAC;YAC5C,MAAM,EAAE,CAAC,KAAK,CAAC;YACf,GAAG,EAAE,CAAC,KAAK,EAAE,YAAY,CAAC;SAC3B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,eAAe;gBACrB,OAAO,EAAE;;;;;;;;;;;;;;;;;;CAkBhB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,kBAAkB,EAAE;QAClB,IAAI,EAAE,kBAAkB;QACxB,WAAW,EAAE,kBAAkB;QAC/B,WAAW,EACT,gDAAgD;QAClD,gBAAgB,EAAE;YAChB,KAAK,EAAE,2CAA2C;YAClD,OAAO,EAAE,2CAA2C;YACpD,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,UAAU,CAAC;QAC7B,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,UAAU,EAAE,UAAU,EAAE,cAAc,CAAC;YAC9C,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC;SAC5B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,wBAAwB;gBAC9B,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6BhB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,YAAY,EAAE;QACZ,IAAI,EAAE,cAAc;QACpB,WAAW,EAAE,4BAA4B;QACzC,WAAW,EAAE,oCAAoC;QACjD,gBAAgB,EAAE;YAChB,KAAK,EAAE,0CAA0C;YACjD,OAAO,EAAE,0CAA0C;YACnD,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,QAAQ,CAAC;QAC3B,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,YAAY,EAAE,gBAAgB,EAAE,WAAW,CAAC;YACnD,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC;SAC5B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,0BAA0B;gBAChC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8BhB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,yCAAyC;QACtD,gBAAgB,EAAE;YAChB,KAAK,EAAE,6CAA6C;YACpD,OAAO,EAAE,6CAA6C;YACtD,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,UAAU,EAAE,OAAO,CAAC;QACtC,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,cAAc,EAAE,KAAK,EAAE,IAAI,CAAC;YACnC,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,EAAE,WAAW,CAAC;SACzC;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,4BAA4B;gBAClC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwChB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,iBAAiB;QAC9B,WAAW,EAAE,yCAAyC;QACtD,gBAAgB,EAAE;YAChB,KAAK,EAAE,6CAA6C;YACpD,OAAO,EAAE,6CAA6C;YACtD,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,UAAU,CAAC;QAC7B,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,gBAAgB,EAAE,UAAU,EAAE,YAAY,CAAC;YAClD,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC;SAC5B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,8BAA8B;gBACpC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoDhB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,UAAU,EAAE;QACV,IAAI,EAAE,UAAU;QAChB,WAAW,EAAE,mBAAmB;QAChC,WAAW,EAAE,wCAAwC;QACrD,gBAAgB,EAAE;YAChB,KAAK,EAAE,iCAAiC;YACxC,OAAO,EAAE,iCAAiC;YAC1C,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,OAAO,EAAE,QAAQ,CAAC;QACpC,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,KAAK,EAAE,gBAAgB,EAAE,WAAW,CAAC;YAC5C,MAAM,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC;SAC7B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA0ChB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,gBAAgB,EAAE;QAChB,IAAI,EAAE,gBAAgB;QACtB,WAAW,EAAE,yBAAyB;QACtC,WAAW,EAAE,qCAAqC;QAClD,gBAAgB,EAAE;YAChB,KAAK,EAAE,uCAAuC;YAC9C,OAAO,EAAE,uCAAuC;YAChD,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,UAAU,EAAE,QAAQ,CAAC;QACvC,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,cAAc,EAAE,kBAAkB,EAAE,YAAY,CAAC;YACxD,MAAM,EAAE,CAAC,KAAK,EAAE,UAAU,CAAC;SAC5B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,4BAA4B;gBAClC,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoEhB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;IAED,iBAAiB,EAAE;QACjB,IAAI,EAAE,iBAAiB;QACvB,WAAW,EAAE,0BAA0B;QACvC,WAAW,EAAE,yCAAyC;QACtD,gBAAgB,EAAE;YAChB,KAAK,EAAE,wCAAwC;YAC/C,OAAO,EAAE,wCAAwC;YACjD,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC;SACxC;QACD,eAAe,EAAE,CAAC,QAAQ,EAAE,MAAM,CAAC;QACnC,kBAAkB,EAAE;YAClB,IAAI,EAAE,CAAC,uBAAuB,EAAE,YAAY,EAAE,YAAY,CAAC;YAC3D,MAAM,EAAE,CAAC,KAAK,EAAE,WAAW,CAAC;SAC7B;QACD,aAAa,EAAE;YACb;gBACE,IAAI,EAAE,qCAAqC;gBAC3C,OAAO,EAAE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA6ChB;gBACO,QAAQ,EAAE,IAAI;aACf;SACF;KACF;CACF,CAAC;AAEF,MAAM,UAAU,qBAAqB,CAAC,YAAoB;IACxD,OAAO,mBAAmB,CAAC,YAAY,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,mBAAmB;IACjC,OAAO,MAAM,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,uBAAuB;IAKrC,OAAO,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QAC3D,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,WAAW,EAAE,QAAQ,CAAC,WAAW;QACjC,WAAW,EAAE,QAAQ,CAAC,WAAW;KAClC,CAAC,CAAC,CAAC;AACN,CAAC"}
|