これで記事の執筆爆速化!Markdownテンプレート

エンジニア

概要

本記事では論文調の記事のテンプレートを提案します.

IEEEの構成を踏襲した方の記事を参考にmarkdownのテンプレートを作成しました.
これにより,日々の記事を作成する際の構成を考える手間を減らすことができました.

Writing Papers

はじめに

この記事を書いた背景

今年の6月頃からブログをはじめて数か月が経ちました.ここで,日々の開発作業と記事を執筆する作業を並行して作業しているとある課題にぶち当たりました.それが「執筆時間が結構かかる」ということです.

「執筆時間が結構かかる」問題

慣れていないということもあり,なかなか記事が進まず時間がかかってしまっています.そこで,実際に時間がかかっていることを思い出してみると構成を考えるのに時間がかかっています.しかも,時間をかけた構成にも関わずあんまり見やすい構成でなく,追加で画像やコード,スクリーンショットを撮影したりと手戻りが多い気がします.そこで,この時間を食っている「構成を考える」作業をテンプレートを使ってある程度決めておくことで作業の質を高めつつ効率よくしていこうと思います.

過去の記事

記事の構成で調べると色々な方の構成を見ることができます.例えば,SEO関係の記事の構成であったり*1,qiita関係の構成2 3 *4を見て見ましたが,どれも自身にはパッとしませんでした.

アプローチ方法

途方にくれていたところ,自身は昔,論文を書いていた学生だったことを思い出し,論文調の文章なら抵抗なく受け入れられる可能性を見出しました.そこで,論文の構成を踏襲し記事のテンプレートを作成しようと思います.

内容

環境

  • markdownが使えれば問題ありません.

解決手法

こちらのテンプレートを作成しましたので,これに則り埋めていきます.
テンプレートがあるだけで,だいぶ作業が捗ります.


# 記事テンプレート

## 概要

<!-- 

1. 何をするのか?
2. どのようにしたのか?
3. その結果何がわかったか?

-->

## はじめに

<!-- 

論文の顔.結論を示さないことがポイント.

-->

### 記事の背景

### 課題

### 過去の記事

### アプローチ方法

<!-- 

記事の独自性を強調するため,入念にサーベイすること

-->

## 内容

### 環境

### 解決手法

## 結論

<!-- 

全体のまとめ. 

1. 何をやったか?
2. どのようにやったか?
3. 解析結果や実験結果から何がわかったか?
4. 本文で取り上げなかった注意事項
5. 今後の課題

-->

## 参考文献

<!-- 

記事を書く上で参考にした文献を挙げる.
本文中で参照していない文献は挙げない.

-->

結論

今回は記事の構成を考える作業の効率化を図りました.記事を書いている言語がmarkdownということもあり,markdownでテンプレートを論文調で作成しました.それにより,構成を考える時間が大幅に短縮できました.さらに,ゼロから考えた構成より読み手の負担を軽減する効果も狙えると考えます.ただし,すべての記事に適用できるという訳ではないと思います.例えば,安全確保支援士の問題解説など,何かを提案する感じのものでない場合は別のテンプレートを考えた方がよいと思います.

参考サイト

コメント

タイトルとURLをコピーしました