LoginSignup
0
0

4章:基本設計仕様書を作成する

Last updated at Posted at 2024-01-25

はじめに

今回は仕様書の作成をしていきます。
作成ツールについてですが、GitLabのWiki機能を使用していきたいと思います。
理由としては下記。

  1. 多くのツールを使うことでの複雑な運用を回避するため
  2. リポジトリ作成ができるので、VSCode上で作成や修正が可能となるため

成果物

Untitled.png

意識した点は下記になります。

  • 仕様書上部に、仕様書の処理目的を記載
  • リレーションは1対1を意識する
  • 記載内容は、クラス名とその目的、値の受渡し
    (細かく書きすぎると、詳細設計書との線引が難しくなるため。)
  • ファイル構成が楽になるようなファイル名にする

感想

GitLabのWiki機能を初めて使いましたが、VSCodeで操作ができてGit管理できるのが
とてもありがたいですね。

Excelは普段から使うため抵抗感無く使用できますが、
変更差分の確認ができなかったり図形で作成してしまうとGrepができなかったりと
後々面倒に思うことが出て来てしまうため、今回は脱Excelを目的としてWikiを使用してみました。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0