テンプレートの主機能
[INPUT001]AsciiDocを使ったテンプレートにしたい
要求の補足 | 内容 |
---|---|
理由 |
AsciiDocは |
説明 |
AsciiDocのコンパイル環境を用意しなければならないというデメリットもある |
[INPUT002]シンプルなディレクトリ構成にしたい
要求の補足 | 内容 |
---|---|
理由 |
ディレクトリ構成が複雑だと、テンプレートの使い方を覚えるのが難しくなるため |
説明 |
これにより、`image:画像.png[]`のように記述するだけで画像を表示できる
[TRANS001]マクロを用意して要求仕様書の枠組みを簡単に書きたい
要求の補足 | 内容 |
---|---|
理由 |
AsciiDocの記法を最小限にするため |
説明 |
AsciiDocの表の書き方は、機能が良い反面、記法が複雑であるため |
[UI001]要求と仕様のIDをAsciiDocのアンカーに設定し、ページ内リンクを簡単に貼れること
要求の補足 | 内容 |
---|---|
理由 |
仕様書内で、ある仕様が別の仕様を参照することがよくあるため |
説明 |
AsciiDocのアンカーを使うことで"<<ID>>"のような記法でリンクを貼れる |
-
[UI001-01] マクロファイル([TRANS001]で定義したもの)にアンカーを設定すること
GitHubと連携する機能
-
ここではGitHubとの連携機能に関する要求仕様を記載する
-
要求仕様IDはGITHUB**とする
[GITHUB001]GitHubへIssueを新規投稿するためのリンクを、各要求と仕様の末尾に配置したい
要求の補足 | 内容 |
---|---|
理由 |
要求仕様について改善提案や質問を簡単に投稿したいため |
説明 |
-
[GITHUB001-01] 要求仕様書マクロファイル([TRANS001]で定義したもの)に、投稿用のリンクを設定すること
-
[GITHUB001-11] 最上位層のadocファイル([INPUT002-01]で定義したもの)で投稿先を設定できること
[GITHUB011]GitHubに投稿されているオープンなIssueを要求仕様IDで検索し、該当したIssueへのリンクを各要求仕様に貼りたい
要求の補足 | 内容 |
---|---|
理由 |
要求仕様に対してどれだけ問題定義されているのかをすぐに把握するため |
説明 |
カテゴリ一覧
記号 | 親カテゴリ | 小カテゴリ |
---|---|---|
INPUT |
主機能 |
入力処理(Input) |
OUTPUT |
主機能 |
出力処理(Output) |
TRANS |
主機能 |
変換処理(Transformation) |
CONT |
主機能 |
制御処理(Control) |
UI |
主機能 |
表示/UI処理(UI) |
DIAG |
主機能 |
診断処理(Diagnosis) |
QFUNC |
品質特性 |
機能性(Functionability) |
QRELI |
品質特性 |
信頼性(Reliability) |
QUSAB |
品質特性 |
使用性(Usability) |
QEFFI |
品質特性 |
効率性(Efficiency) |
QMAIN |
品質特性 |
保守性(Maintainability) |
QPORT |
品質特性 |
移植性(Portability) |