概要
趣味プロジェクトの進め方とそのドキュメント化（Qiitaやブログへの投稿）について考えたことをまとめてみた。
はじめに
2年前くらいから趣味プロジェクトをQiitaに投稿するようにしている。
理由は、こんな感じ。
- アウトプットしたほうが勉強になる（気がする）
- 人のためになる（かもしれない）
- アピールできる（かもしれない）
- 反応あるとうれしい
デメリットは、こんな感じ。
- 時間かかる
- 公開しちゃいけないことを公開しちゃう可能性がある
- 「いいね」の数が気になりすぎる
効率化のためにも、誰かに訴えられないためにも、目的を見失わないためにも、一度手順を見直してフレームワーク化しようと思う。
趣味プロジェクト？
趣味でやってるプロジェクトを勝手にそう呼んでる。大体、ひとりでやってる。
それなりに時間がかかるので、他のことにも役立つことをしがち。仕事と関係するとか、育児・家事に関係するとか。
面白いものできたら、家族とか友人とか同僚に見せて自慢することで、モチベーションをキープしてる。
心構え
- うまく行かなかった場合でも、ドキュメントを公開する。
- うまく行く方法だけじゃなくて、つまづいたところも公開する。
- うまくまとまらなくても公開する。
- 他の人がやってるのと同じことでも、環境が違ったら公開する。
誰かが困って検索したときに、役立てることを気にかけたい。
時間とれなかったりして、あまりできてないけど・・・。明日からちゃんとする。
進め方案
こんな感じで進める。
時間とれなかったりして、あまりできてないけど・・・。明日からちゃんとする。
順番は、適当に変えて実行する。
- やりたいことを決める
- プロジェクトに名前をつける
- スケジュールを立てる
- 技術を調査する
- 作り方を決める
- 作るものの仕様と評価方法を決める
- スケジュールを見直す
- ドキュメントで書くことを決める
- ノートを取りながら作る
- ノートを整理して公開する
- フィードバックもらって更新
気をつけること
ここらを気をつけたい。
- 気に入った名前をつけること
- スケジュールをちょいちょい見直すこと
- 大きな変更があるときは、とりあえず、やったことをまとめて公開すること
- キャプチャ画面とか写真とか図を作業しながら残すこと
悩ましいのは、取ったノートの不要になった部分をどうするか。捨てるか、どこかに公開せずに保存しておくか、悩ましい。趣味なら捨ててもいいかも。まじめに保存するのは管理がめんどい。
書くこと
ここらへんは書きたいなと思ってる。
概要
やったことの概要を書く。できるだけ完結に。
はじめに
背景とか課題とか書く。
環境
再現性キープするために、環境を書く。サボりがち。
おわりに
結果と感想と次のアクションと他への応用の可能性について書く。
更新履歴
サボりがち。更新そのものもサボりがち。
参考文献
最近は、最後に書くより、文中に書いちゃったらいいかと思ってる。
最後に書くと文章中の引用箇所とリンクをつなぐのめんどいから。
ただ、文章途中で出てくると、文章の流れが途切れるかもしれなくて、悩ましいところやけども。
おわりに
そこそこ、頭整理できた。
ソースコードと同じようにドキュメントのアウトプットもレビューしてほしいところやけど、誰にしてもらうのがいいんやろ。悩ましい。
また、書き忘れたり、考え方かわったら、そのうち更新したい。