6/18.log

最近プログラミングそのものというより開発手法やアーキテクチャについて書いていることが多い気がします。

プロジェクトの参入について

今週から研究室で作成しているアプリケーションの別のサービスの機能を実装することになりました。マイクロサービスで開発しているのですが別のサービスにも関わっていくといった感じです。もちろんアプリケーションに関わる者としてどのサービスが何をしているのか、目的や使用技術に関してはわかっています。しかし、コード自体の詳細については全くわからないです。

とりあえずそのサービスの開発を担当しているメンバーからサラッとした説明はもらったのですが正直なところ全くといってもいいくらい理解できていないです。これはそのサービス自体の特性上しょうがないのですがディレクトリ構造が結構複雑になっていてどこがどのコードを担っているのかわかりにくいです。そこで最近はコードを読むことによって理解をしようとしています。

一応今週いっぱいかけたらある程度は状況の把握ができそうな見通しです。

apiのルートなどはswaggerで良さそうで処理はシーケンス図などで表す。ディレクトリ構造の簡単な説明はREADMEとかに書けばある程度は簡単になりますかね？

実は説明する必要になりそうで

自分たちの研究室にももちろん3年生がいます。入ったのはもう少し前なのですが今の時期くらいから自分たちの研究に入ってきてくれそうです。もちろん事前に簡単にではありますが研究の概要は説明しているものの流石に理解している人はいないとは思っています。そもそも作成中のアプリケーションに関しては概要すら説明していないです。

そこで来週くらいから自分たちの研究に興味がある人に集まってもらってもう少し詳しい説明を行う予定です。しばらくは勉強会なり具体的な説明を行うのですがそれに伴いアプリケーションのコード説明も行う必要がありそうです。

どのようにすれば新規で入る人に対してわかりやすい説明ができるか。考えてみたいと思います。