日報 - OSS Gateオンボーディング

新人と先輩は作業した日はその記録を https://github.com/oss-gate/on-boarding にpushします。OSS Gateオンボーディングではその記録のことを「日報」と呼びます。このページではなぜ日報を書くのかおよびどのように書くのかを説明します。なお、OSS Gateオンボーディングをどのように進めるのがよいかはまだ手探りの段階であり、実際に試した経験を踏まえてやり方を見直したり、そもそも日報を書くことをやめたりする可能性もあります。

なぜ書くか - 目的

次のことを実現するために日報を書きます。

OSS Gateオンボーディング後も新人が対象OSSの開発に継続的に参加する
今後のOSS Gateオンボーディングの進め方を改善する
今後のOSS Gateオンボーディングに参加する人が参考にできる情報を増やす

1.はOSS Gateオンボーディングが目指していることです。作業の記録を残すことで1.の実現に向けて進められているか、1.の実現を阻害する課題はないかを見直す機会にします。この記録を元にOSS Gateオンボーディング中に進め方を調整し、1.を実現できる可能性を高めます。

2.は1.と関連します。1.は今回のOSS Gateオンボーディングの改善のためですが、2.は今後のOSS Gateオンボーディングの改善のためです。日報から得られた知見はできるだけ今回のOSS Gateオンボーディングで活かしますが、中には今回のOSS Gateオンボーディングでは活かすことが難しい知見もあるはずです。たとえば、大きく進め方を変えないと活かすことができないような知見です。そのような知見は今後のOSS Gateオンボーディングで活かします。今回の新人が、今後、先輩としてOSS Gateオンボーディングに参加するときには生かされているはずです。

3.は今後のOSS Gateオンボーディングの発展のためです。今後、はじめて新人・先輩としてOSS Gateオンボーディングに参加する人たちはたくさんいます。（いるはずです！）そんなはじめての新人・先輩が過去にOSS Gateオンボーディングがどのように進められたかを確認できれば、どのように進むのかイメージできたり、自分ならこのように進めたいなと検討する有用な材料になるはずです。

日報ではこれらのことの実現を目指します。

どのように書くか

日報をどのように書くかを説明します。前述の目的を実現するための書き方にすることはもちろんですが、次のことも重視します。

できるだけ手間をかけない
持続的に参照可能にする

OSS Gateオンボーディングの主要なプロセスは新人と先輩とのやりとりと新人の作業です。これらのために使う時間をできるだけ減らさないために日報のために使う時間はできるだけ短く済むことを重視します。

日報は書いて終わりではありません。書いた後に、書かれた知見を活かすことが重要です。そのため、書いた後もずっと参照できるようにすることを重視します。

できるだけ手間を書けずに目的を実現するためにテンプレートを用意します。

持続的に参照可能にするため、書いた日報はhttps://github.com/oss-gate/on-boarding/tree/main/proposals/${期間}/${募集要項ID}/daily-report-${ID}.mdにpushします。たとえば、 https://oss-gate.github.io/on-boarding/proposals/2021-08/kenhys-maintain-debian-packages/ の先輩が書く日報は https://github.com/oss-gate/on-boarding/tree/main/proposals/2021-08/kenhys-maintain-debian-packages/daily-report-kenhys.md にpushします。新人・先輩は https://github.com/oss-gate/on-boarding/ にpushする権限があるので直接pushできます。

なお、一緒に作業すると決めた日以外にも個人的に作業を進めるときもあるでしょう。そのときも日報を忘れずに書いてください。

一緒に作業する日は作業時間が決まっていますが、個人的に作業する日は作業時間が決まっていないはずです。実際にどれくらい作業したか、日報に時間も記録しておくとよいでしょう。あとでその作業にどれくらいかけていたかをふりかえるときに役立つはずです。

テンプレートは次の通りです。今後、OSS Gateオンボーディングを実施した知見を活かしてテンプレートの中身は改善予定です。

https://github.com/oss-gate/on-boarding/tree/main/process/daily-report/template.md に同じ内容のファイルがあるので最初に日報を書くときはこのファイルをコピーして使ってください。

---
layout: page
title: 日報 - ${ID}
---

<!-- ↑の${ID}は自分のGitHubのIDに置き換える。例：日報 - kenhys -->

<!-- 新しい日付を上に書く。つまり、追記するときは上に追記する。 -->

## 2021-08-18

### やったこと

  * ...

### よかったこと

  * ...

### 気になったこと

  * ...

### こうすればもっとよくなるかも

  * ...

### その他

...

### 日報の使用時間

N分

## 2021-08-11

### やったこと

  * ...

### よかったこと

  * ...

### 気になったこと

  * ...

### こうすればもっとよくなるかも

  * ...

### その他

...

### 日報の使用時間

N分