見出し画像

じぶん Release Notes を書いていく

振り返りのために「じぶん Release Notes」を書いていこうと思います。
まずは習慣作りからですが、ざっと軽いルールを決めておきます。
以前からやろうと思っていましたが、この記事まとめるだけで2時間かかりました。

媒体について

エンジニアリング的なことについてはGithub Gistに記載します。
noteにはエンジニアリング以外を記載し、上記Gistを埋め込もうと思います。

更新頻度(リリースタイミング)について

毎月の月初(1~7)に前月の振り返りをリリースできたらな、と考えています。
つまり月次リリースを目指します。

ファイル名/タイトルについて

Gistについては、ファイル名を「release_notes_ver-0_yy_mm.md
noteについては、「じぶん Release Notes (ver 0.yy.mm)
※「yy」は私の年齢、mmは振り返り月

noteのヘッダについて

Canvaで毎度テキスト(小見出し)を白字で右上に埋め込んでいきます。
参考:今回のヘッダ画像

「みんなのフォトギャラリー」にファイルをあげました。
キーワードは、「じぶんリリースノート」「じぶんReleaseNotes」で検索できます。

記載内容について(Gist)

下記のテンプレートに従って、noteを公開するまでは非公開状態で毎週記載していきます。noteを公開するタイミングでGistを公開状態<Make Public>にします。

記載内容について(note)

下記の見出しに従って下書き状態で毎週記載していきます。
公開のタイミングで整形します。
・🛠エンジニアリング
・🎁買ったもの
・🤔KPT(KPT)
・😇所感

noteのタグについて

  • エンジニア

  • 振り返り

  • 月報

  • じぶんリリースノート

  • 振り返り月報

  • じぶんReleaseNote



いいなと思ったら応援しよう!