README.md

ドキュメントテンプレート

ソフトウェア開発時に作成するドキュメントのテンプレート集です。

コンセプト

成果物としてではなく、開発効率を向上させる手段の1つとして作成されるドキュメントを対象とします。つまり、反復型開発などにおいて継続的に更新されるものです。そのため、更新や差分表示のしやすさを考慮し、極力テキスト形式を使用しています。

また、プロジェクトによって求められる内容や粒度は異なるため、適宜調整して使用されることを想定しています。

プロジェクト単位

プロジェクト単位の文書一覧です。

• 概要
  • 例
• 運営ルール
  • 例
• 用語集
  • 例

リポジトリ単位

ユーザ向け

ユーザを対象読者とした文書の一覧です。

• 概要
  • 例
• コマンド
  • 例
• 設定
  • 例
• バグ報告テンプレート
• 改善提案テンプレート
• API
  • OpenAPIなどで自動生成

開発者向け

開発者を対象読者とした文書の一覧です。* がついている項目はGUIアプリのみが対象です。

• 配置図
  • 例 (プレビュー)
• シーケンス図
  • 例 (プレビュー)
• UI Flows *
  • 例 (プレビュー)
• 画面遷移図 *
• 画面設計書 *
  • 例
• クラス図
  • 例 (プレビュー)
• フローチャート
  • 例 (プレビュー)
• 状態遷移図
  • 例 (プレビュー)
• 状態遷移表
  • 例
• データフロー図
  • 例 (プレビュー)
• コミュニケーション図
  • 例 (プレビュー)
• リポジトリ運用ガイドライン
  • 例
• Architectural Decision Records
  • 例
• プルリクエストテンプレート
• 要求仕様書
  • 例
  • エクセル版
• テーブル定義
  • ORMのスキーマファイルなどを流用するか自動生成
• ER図
  • ORMのスキーマファイルなどを流用するか自動生成

Setup Previews on Visual Studio Code

Mermaid

• Markdown Preview Enhanced

UI Flows

• Vscode UiFlow