目的

　このサイトは、「FlowChat」（Railsアプリケーション）を開発するための設計書や開発に関する記録を閲覧可能にすることを目的とする。

　アジャイル的に早く開発する場合(開発方法に関してを参照)、開発の効率化が見込まれる場合を除き基本的にドキュメントの制作は控えるべきである。しかし、本件はどのように制作したか？なぜそうしたかを明確に説明する必要があったため、本サイトを作成した。

サイトの読み方

　ホームから基本的にすべての資料にアクセスできる。
開発手順を順番に確認したい場合は、ホームにあるリンクを上から順にアクセスすることで閲覧できる。

GitHubリポジトリ

FlowChatアプリケーションのGitHubリポジトリは以下のURLが示す場所にある。
https://github.com/Nagasaka-Hiroki/rails_work_1

UMLについて

　使用するツールはplantumlを使用する。このツールはUMLをテキストベースで作成することができるため管理がしやすく、またVisutal Studio Codeで便利な拡張機能がありN君の開発環境上（開発環境と本番環境についてを参照）で扱う上で非常に便利である。また、OSSライセンス（GPLライセンス）であるため導入しやすい点も利用している理由である。ただ細かな配置調整を苦手としており配置など少し変に描画されることがある。この点は目的に合わせて調整や受容して設計を行っていく。

　UMLのバージョンはplantumlがUML2の書き方をサポートしている点、参考にしている書籍がUML2で書かれている点から、本件での設計においてもUML2を使用して設計を行う。

　また、データベース設計についてはUMLではないがE-R図を使用する。これはRDBMS(SQLite)ではE-R図を利用したほうが効果的にデータベース設計ができると考えたためである。E-R図についてはPlantUMLで描画できるため、UMLと同様にPlantUMLで描画する。

このサイトの作成について

　このサイトはGithub Pages上でデプロイするため、jekyllを使用して作成している。テーマなどは作り込みの本質ではないと判断しデフォルトのままにする。
　また、通常のWebサイトであれば見出しタグなど(h1,h2など)のそれぞれの目的に応じてタグを変更すべきである。しかし、本サイトは直接検索エンジンから検索してアクセスしてもらうことを想定せず、資料をWeb上で閲覧可能にすることを重視している。そのため、見出しタグなどは主として見た目を変更する目的で使用し、その他のタグに関しても本来の目的と異なる用途で利用する場合があり、それを許容する前提で作成を行う。