背景
ソフトウェアエンジニアとして活動する中で、個人の備忘録をかねてBloggerで技術メモを作成することにした。読みやすい技術メモを作成するため、ドキュメントルールの作成を行った。
記事の目的
読みやすい技術メモ作成するため、技術メモのドキュメントルールを作成する
ドキュメントルール
ここでは、技術メモのドキュメントルールついて記載する。
記事のテーマ
- 本ブログに記載するテーマは、IT関連のものに限定する。
- １つの記事に記載できるテーマは、１つに絞る。複数のテーマについて記載する場合は、記事を複数に分割した上、親となる記事を作成する。
記事の構成
- 技術メモは、技術メモのテンプレート構成に従って作成する。
- 「表示形式」は、「見出し」、「小見出し」、「標準」の3種類のみを使用する。
- 読みやすくするため、極力箇条書きで記載する。
記事の内容
- 最低限の情報のみを記載し、感想や所感は記載しない。
図の作成方法
- 技術メモでは、基本的にPlantUMLで図の作成を行う。
数式の作成方法
- 技術メモでは、基本的にMathJaxで数式の作成を行う。
コードの埋め込み方法
- 技術メモでは、基本的にGoogle-code-prettifyでコードの埋め込みを行う。
import numpy as np
a = 10
まとめ
- 技術メモ作成にあたり、ドキュメントルールを作成した
- 今後のブログ更新は、上記ルールに従って作成する
参考文献
変更履歴
- 2019/08/15: 新規作成
0 件のコメント:
コメントを投稿