継続的ドキュメンテーション(LIFULL)
Lifull
現在は主に社内Wiki、ドキュメンテーション専用GitHub Repository、そしてGitHub Discussionsの3つをツールとして活用しドキュメンテーションを実施しています。
社内wikiはエンジニア以外が見る、しっかりしたもの
repoはエンジニアが見る、しっかりしたもの
discussionはエンジニアが見る、とりあえず記録しておきたいもの
Q: なんでrepoだけじゃないん？
普段書くのが辛いから
textlintいちいち通す必要の辛さと、階層構造のメンテ
ラフに書けるようになった
階層ではなくフラット with ラベルとタグ
ADR本来の「"アーキテクチャ" の決定事項」について書く、はあまり守ってないようだsta.icon
Issueでメモするみたいに雑多やな
元の定義ではアーキテクチャに関する決定事項やその背景を記録することに焦点を当てていますが、バックエンド刷新チームでは実装に関する事柄も含めアーキテクチャ以外の事柄でも記録しています。
むしろ注目したのは「誰でも見れる・コメントできる」「気軽に書ける」の二点
sta.icon
マトリックス思いついたわ