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

エンジニア

概要

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

前回はIEEEの構成を踏襲した方の記事を参考にmarkdownのテンプレートを作成し,日々の執筆作業を大幅に短縮できました.

しかし,構成が細かい粒度のため軽い記事を書く際に結構しんどくなってきたので,本記事では【Lite 版】を提案します.

はじめに

この記事を書いた背景

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

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

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

過去の記事

こちらの前回書いた記事ではIEEEの構成を踏襲した方の記事を参考にmarkdownのテンプレートを作成しました.

これで記事の執筆爆速化!Markdownテンプレート
本記事では論文調の記事のテンプレートを提案します. IEEEの構成を踏襲した方の記事を参考にmarkdownのテンプレートを作成しました. これにより,日々の記事を作成する際の構成を考える手間を減らすことができました.

その結果,日々の執筆作業を大幅に短縮できました.しかし,Qiita等の他の人のコードの動作確認などの軽い記事を書く際に,このフォーマットに従って執筆してしまうと,前振りの部分の分量よりも本体の分量が少なくなるという事態に陥りました.

そこで,軽い記事を書く際には別のテンプレートを作成することにしました.

アプローチ方法

前回のテンプレートから大幅に項目を間引きました.

これも今後足りない部分や,蛇足感がある部分はアップデートしていく予定です.

内容

環境

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

解決手法

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


# 記事テンプレート Lite

## はじめに

<!--  記事のおおざっぱな説明 -->

## 環境

<!-- 

動作環境

- UE5
- Python3.8
- Docker 18.2
- Windows11

-->

## 内容

<!-- 

プログラムの説明やコードを記載

-->

## 結論

<!-- 

全体のまとめ. 

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

-->

## 参考文献

<!-- 

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

-->

結論

今回は比較的に軽い記事を書くとくに使用できるテンプレートを作成しました.これで,関数や動作,プラグインなどの確認のように後追いでやるような軽い記事を書くときの効率が上昇します.しかし,まだまだ完成形ではない感じがしますので,気がついた段階で修正していこうと思います.

こちらの記事は,今回紹介したテンプレートを使用しています.参考にどうぞ

【python】UnrealEngine5のPythonでCSVを出力してみる【UE5】
UnrealEngine5のPythonでCSVを出力してみます.

コメント

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