USDM (Universal Specification Describing Manner) Template

USDMを適用した要求仕様書をAsciiDocで記述するためのテンプレートです。

テンプレートの使用例

• USDM Templateの要求仕様書

テンプレートの特徴

• AsciiDocでUSDMを適用した要求仕様書を記述できる
• 初めてAsciiDocを触る人でも記述できるシンプルな構成
• 要求と仕様の末尾には、GitHub Issue投稿用のリンクが生成される

使い方

asciidoctorのインストール

$ sudo apt install asciidoctor

テンプレートのダウンロード

$ git clone https://github.com/ShotaAk/usdm_template.git

AsciiDocファイルをコンパイルからHTMLファイルを生成

$ cd usdm_template
$ asciidoctor requirements_specifications.adoc

生成されたHTMLファイルをブラウザで開く

$ google-chrome requirements_specification.html

要求仕様書の書き方

要求仕様書を追加する場合は、chaptersディレクトリにadocファイルを追加します。

追加したファイルをrequirements_specifications.adocにincludeします。

include::chapters/something.adoc[]

adocファイルに要求を追加する場合は、snippets/requirements.adocを使用します。

• :id:には、要求のIDを指定します。
• :requirement:には、要求を指定します。
• :reason:には、要求の理由を指定します。
• :explanation:には、要求の説明を指定します。

:id: 要求のID
:requirement: 要求
:reason: 要求の理由
:explanation: 要求の説明
include::snippets/requirement.adoc[]

adocファイルに仕様を追加する場合は、snippets/specification.adocを使用します。

• :id:には、仕様のIDを指定します。
• :specification:には、仕様を指定します。

:id: 仕様のID
:specification: 仕様
include::snippets/specification.adoc[]

テンプレートの仕様

USDM Templateの要求仕様書 を参照してください。

LICENSE

Apache License Version 2.0