OSS Hack Weekend: gates1de: SwiftHTTP: Swift: 作業ログ

gates1de commented 9 years ago

作業ログは、参加者が、このイベントを通して得るものをより増やすために重要になります。なぜなら作業ログがメンターからのフィードバックをより充実させるからです。

作業ログを元にメンターと「ふりかえり」をするタイミングがあります。「ふりかえり」では次のことをします。

参加者は作業ログの内容を順にメンターに説明する。
メンターは説明を聞いて参加者にフィードバックをする。

メンターは次のようなフィードバックをします。これは、参加者とは違う視点から参加者の行動を観察することおよびメンターの経験があるからできることです。（「ふりかえり」の前にこんなフィードバックをよろしくお願いします！とお願いすると効果が高まるので実践してみましょう。）

参加者が気づかずにやっていたよい行動に気づくきかっけを与え、今後もその行動を継続するように促します。
参加者が困っていることについて、解決策を一緒に考えてくれます。
適切な質問をして参加者が整理できていない行動や考えを整理してくれます。
参加者が「問題」だと認識していないこと（「問題発見」は難しい！）をメンターの視点から「問題」だと見つけてくれます。「問題」がはっきりしたら直しましょう。
参加者が次にどの方向に進めばよいかを整理してくれます。

このように、参加者の作業をメンター視点で一緒に整理し、参加者の今後の行動に活かす活動がここでいう「ふりかえり」です。そのため、「参加者にとって」ログに残すべきかどうか、という視点ではなく、「とりあえずログに残す」という視点でログを残してください。これは、参加者が重要だと判断しなくてもメンターの視点から見たら大事なこともあるからです。

ログに残すときは次のようなときです。

違う作業を始めたとき（インストールを始めた、動作確認を始めた、テストを始めた、とか）
詰まったとき（インストール時にエラーがでた、ビルドが失敗した、とか）
issueを出したとき
pull requestを出したとき

ログに残すことは次のことです。「備考」以外は作業の邪魔にならないように一言でよいです。備考は作業に役立つので必要な分だけ書いてください。

作業（やること、やっていること、やったこと。）
思っていること（そのときどう思っているか。）
備考（必要な付加情報。）

ログはコメントとして追記していってください。テンプレートは次の通りです。

* 作業（ここにやること、やっていること、やったことを書く）
* 思っていること：（今どう思っているかを書く）

備考：（必要なら必要なだけ書く。必要ないなら書かなくてもよい。）

例1（備考なし）：

* 作業：インストールを始めた
* 思っていること：ドキュメント通りに進めれば大丈夫だろう

例2：

* 作業：インストールが失敗した
* 思っていること：ドキュメントに手順が足りない？

備考：エラーメッセージは次の通り

```text
XXX is not found

必要なファイルが足りないのかなぁ。

gates1de commented 9 years ago

作業: インストール
思っていること: インストールの方法が下に来てる...けどまぁ大丈夫

gates1de commented 9 years ago

作業：POSTでJOSNデータを取得
思っていること：JSONRequestSerializerとJSONResponseSerializerを個別に設定しておかないといけないのは面倒かも...

gates1de commented 9 years ago

作業：レスポンス周りの調査
思っていること：errorに対するレスポンスが404, 401, -1001しかない...?

gates1de commented 9 years ago

作業：HTTPのステータスコードと説明について, enum型で定義して親切なHTTPレスポンス対応を作成
思っていること：もしかしていらないヤーツがあるかも...

gates1de commented 9 years ago

作業：4xxと5xx系のエラーステータスコードが返ってきた時にエラーログを出力(デバッグ作業)
思っていること：いい感じにエラーの種類を分別できるようになったけど, コード量が多すぎてちょっと...という感じ

gates1de commented 9 years ago

作業：Pull Requestを送る
メッセージ： I think a Developer will be able to error handling correctly. So, I added a variety response message every Response Code.

gfx commented 9 years ago

I'd like to handle errors other than 401 and 404, so I've implemented all the HTTP status codes and messages in HTTPStatusCode. Can you review it please?

とかかなあ。

kou commented 9 years ago

お疲れ様でした！

clear-code / sezemi-2015

OSS Hack Weekend: gates1de: SwiftHTTP: Swift: 作業ログ #29