Typstで書くソフトウェア設計書のテンプレート

注意

• 本ページは作成途中で、私の勉強の進度と並行して更新します。
• 現段階ではtypstのテンプレートには手が出ておらず、設計書の目次を整理しているところです。
• ソフトウェアの設計プロセスはプロジェクトに依存するものであり、正解など無いようです。あくまで私にとって便利な設計書であることにご留意ください。

目的

本ページでは、ソフトウェア設計におけるＶ字プロセスの左側に必要な設計書をtypstで作成するためのテンプレートを作成することを目的とします。
不思議なことに毎回締め切りに追われる中で設計・開発を行っているため、テンプレートを作成しておくことで、短期間でも後から困らない設計書が作成するための準備をしておきたいのです。
(意外と設計書のテンプレートを調べても出てこず、とりあえず書き始めてみる人に不親切な分野な気がします。。)

対象の読者

顧客の要求を自身で調査しまとめ、要件に落とし込み、ソフトウェアの基本設計、詳細設計（果ては実装まで）を担当するような人を対象とします。

参考

typstのテンプレートは以下のページを参考にしました。

概要

対象とする設計書は以下の通りである。
プロジェクトごとに粒度・流儀が異なると思いますが、私がよく作成する設計書・粒度で進めます。

• 要求定義書
• 要件定義書
• 外部設計書
• 内部設計書
  • (option)　データベース定義書
  • (option)　関数構造定義書
• (option)　コーディング規約

Github

作成中のテンプレート