ITエンジニアの技術メモ: 技術メモのテンプレート

2019/08/14

背景

ソフトウェアエンジニアとして活動する中で、個人の備忘録をかねてBloggerで技術メモを作成することにした。有効なメモを効率的に作成するため、テンプレートをまず作成する。

有効なメモを効率的に作成するため、技術メモのテンプレートを作成する

ここでは、技術メモのテンプレートに関する説明について記載する。

技術メモは、「背景」、「記事の目的」、「記事の内容」、「まとめ」、「参考文献」、「変更履歴」の6項目から構成される。以下では、各項目の詳細について解説する。

どんな人も、一回で完璧な文章を書くことはほぼ不可能である。

ここでは、技術メモ内における図の作成方法について記載する。
技術メモでは、基本的にPlantUMLで図の作成を行う。

PlantUMLを利用した図の作成方法の詳細は、別途記事を作成する。

ここでは、技術メモ内における数式の作成方法について記載する。
技術メモでは、基本的にMathJaxで数式の作成を行う。
\[ \sum_{i=1}^{n}i = \frac{1}{2}n(n+1) \]
MathJaxを利用した数式の作成方法の詳細は、別途記事を作成する。

ここでは、技術メモ内におけるコードの埋め込み方法について記載する。
技術メモでは、基本的にGoogle-code-prettifyでコードの埋め込みを行う。

import numpy as np

a = 10

Google-code-prettifyを利用したコードの埋め込み方法の詳細は、別途記事を作成する。