Skip to main content

このHandbookについて

このHandbookでは、AIやシステム開発で私が得た知見を簡潔にまとめております。 Handbookの目的・記事の書かれ方について、この記事で詳細を説明します。

目的​

Handbookは主に以下の目的で執筆しております。

  • 自分用のメモとして残したいため
  • 一緒に開発するメンバへ共有するため
  • 世界の技術コミュニティに少しでも貢献するため

会社の技術ブログじゃダメなの？​

これらを達成するものとして、会社に属している場合は、

  • 社内の内部ドキュメント
  • 会社の技術ブログ

でも同様の役割を担える思われるかもしれません。

しかしこれらは、

  • 退職すると見れなくなる
  • 内部RVが厳しく気軽に書けない

といった課題があります。

より自由に、オープンに、継続的に知見を蓄積することを目的とし、このHandbookを運用していければと 考えています。

記事の構成​

「簡潔かつ低コスト」な記事を執筆するため、本Handbookでは、基本的に以下の構成で記事を執筆しようと 考えています。

  • 記事タイトル: できるだけ短く簡潔に書きます。
    • ヘッドメッセージ: 「○○は○○○です。」で始まる。見ればサマリがすぐわかる。
  • 見出し: テーマが変わる時は見出しをつける。
  • 参考文献: 参考にした文献があれば記載する。

執筆に際し注意すること​

「簡潔かつ低コスト」を意識した執筆を心がけます。具体的には以下のポイントに注意することになると思われます。

とにかく簡潔に書く:​

詳しく書いた記事はきっと誰かが書いている。短い時間で書く -> 短い時間で読む を意識して書く。

ある程度雑でも良い:​

最低限の体裁とファクトチェックが大丈夫そうであれば、ガンガン書いていく。 「質より量」「質よりスピード」を意識して書く。