技術ノートの取り方
使用アプリ
その他類似アプリ
勝手に宣伝
今回使用しているinkdropの開発者であるTakuya Matsuyamaさんの紹介をさせて下さい。
大阪で個人アプリ作家として活動されている方で、Youtubeにておしゃれなコーディング動画を投稿されているのでぜひ見て下さい！！
Home page / Youtube / X / Instagram
どんな時にノートを作成するのか
まずはどのような用途でノートを作成するのか洗い出します。
- 新しい言語、技術を学ぶ時
- プロジェクトのバグ修正、機能の改修作業を行う時
洗い出した結果、私はこれらの２つの用途でノートを作成することが分かりました。
それではこれらのノートをどのようにして分類し作成していくのかを考えていきます。
ディレクトリ毎に分類する
まず一番の親となるディレクトリを２つ作成します。
- 新しい言語、技術を学ぶ時：
Learn - プロジェクトのバグ修正、機能の改修作業を行う時：
Project
Learn
こちらには新しい言語、技術を学ぶ時に作成するノートを保存していきます。
ただLearnディレクトリに全て保存する訳ではなく、さらにもう一段階ディレクトリを分割したいと思います。
- Android
- iOS
- Web
Project
こちらにはプロジェクトのバグ修正、機能の改修作業を行う時に作成するノートを保存していきます。
こちらはProjectディレクトリの中にProject nameディレクトリを作成しそのプロジェクトで起きた内容だけを格納します。
ノートのテンプレートを作成する
ノートの分類ができたので、次はコンテンツ部分を考えていきます。
タイトルを考える
タイトルはそのノートが細かく何をしたのかが瞬時にわかる必要があります、なので以下のようなタイトルは避けるべきです。
- Reactの学習
- ログイン画面のバグ修正
Reactの何を勉強したのか、何のバグを修正したのかを明確したタイトルにすべきでしょう。
チーム開発をした事がある人であれば分かると思いますが、プルリクエストのタイトルだけで何を編集したのか理解して貰えるように考えましょう。
- 基本文法の学習
- ログイン画面のユーザー作成の機能修正
言語などをタイトルに含めなくても後に説明するタグを用いることで表現できます。
もっと良いタイトルの付けかたがあると思いますが現状は考え方だけでも整理できれば十分です。
コンテンツを考える
タイトルをつける事ができたら次はコンテンツに書く内容を考えます。
Learnの場合
含める内容は以下になります。
- 参考サイトURL
- サイトに記述されていたコード
- 自分なりの解説
Projectの場合
含める内容は以下になります。
バグ修正の場合はエラーコードもしくはエラー画面を必ず貼り付けましょう。
- 参考にしたサイト
- 自分が考えたコード
- 改良した内容のコード
終わり
以上でどのようにして技術ノートを作成するのかについての記事を終わります。
私もまだまだ模索している段階ですので、皆さんの勉強方法なども教えて下さると嬉しいです
Discussion