はじめに
現在オンラインスクールで Java を学習しています。
カリキュラム完走後、ポートフォリオの作成 を開始しましたが、要件定義 や ER図 など 事前準備が大切 であると知り、ドキュメントを作成しました。
その中で疑問に思ったことや学んだことを残しておこうと思い、この記事を作成しました。
ドキュメントについて
スクール内では、要件定義・ER図・テーブル構成などを学びましたが、詳しくは学んでおらず、「こんなのがあってこのドキュメントに沿って作成していくんだよ」という内容でした。
新人がここを直接担当することはないため、「知っておく」 ための解説のみが行われているようでした。
今回ポートフォリオ作製にあたり、オリジナルのアプリケーションに必要なドキュメントを AIと壁打ち しながら作成をしました。
作成したドキュメント
-
user-storise.md(ユーザーストーリー) -
api-design.md(API設計) -
requirements.md(要件定義) -
er-diagram.md(ER図) -
table-definition.md(テーブル定義) -
wireframes.md(画面構成・遷移図)
疑問点と考察
そもそも 正しい情報 を判断できないためAIとの会話で作成しましたが、この情報が正しいのかもわかりませんでした。
そこで、ポートフォリオ作成時に必要なドキュメントを検索してみました。
その結果、「そもそもドキュメントは実務でGitHubにpushすることは機密情報の漏洩リスクからpushすべきではない」 という意見がありました。
ネット上にあるポートフォリオを見てみましたが、ディレクトリ内にdocsがない（私が見つけられなかっただけかもしれませんが）ものが多く見受けられました。
しかし、情報漏洩リスクがあるため実務では含めないのであって、機密情報を含めなければ制作物として載せてもいいのではないか？と考えました。
GitHubにあげるものは、中身の精査と把握が重要であり、docsを載せるか載せないかは本質ではないと考えました。
まとめ
今回ポートフォリオ作製の初期に作成すべきドキュメントをどう取り扱うべきかを考えさせられました。
異業種からの挑戦であり、普段なにげなく扱っているデータや情報に対し、細かくセキュリティや必要性を考えなければならない と学びました。