見出し画像

【Asciidoc】論文のテンプレート ー スケルトンを作る ー

「(筑波大学)上保研究室」の「Asciidoctorを用いた論文作成」に行き当たって、論文作成に「Asciidoc」を積極的に利用しているところもあるのだと知った。海外では普通に利用されているだろうなとは思っていたが日本ではTexかワープロが主流なので殆どないのではと考えていました。

欧米の論文ではAsciidocの構文そのままで比較的簡単に論文の要項を満たしてくれます。論文用のスケルトン等もかなりあると思われます。しかし、日本だとFontの問題も含めかなり手こずる印象があります。(自分の中ではマニュアル向けの印象が強い。)

それでも利用しているグループがあるなら「論文のテンプレートをいっちょ作ってみるか」と思い立ったので、この記事から数回は論文テンプレートの話になります。

「上保研究室」のサイトをざっと見たところ、章立ては「IMRaD」に沿っているようです。
「IMRaD」については下記を参照してください。

で「IMRaD」に従って「Asciidoc」のスケルトンを作ってみました。

= 論文名 :: 副題
執筆者 氏名
:doctype: article
:encoding: utf-8
:lang: ja
:toc: left
:numbered:

[preface]
==  Preface(序文)

目的:: 序文は、著者が研究に取り組んだ動機や研究の背景を読者に紹介するための部分です。研究の経緯や重要性、個人的な体験、感謝の気持ちを述べることが多いです。
書くべきこと*:
* 研究の背景やきっかけ
* 研究の目指した目的や意義
* 研究に取り組んだ経緯や、もしあれば研究中に遭遇した挑戦や問題
* 感謝の意(特に研究に協力した個人や機関に対して)
注意点::
* 序文はあくまで本論の補足的な内容であるため、内容を簡潔にまとめることが大切です。
* 研究の内容に直接関係ない詳細な話や無駄な情報は避け、読者にとって本論に入る前に有益な情報だけを提供します。

[abstract]
== Abstract(要約)

目的:: 研究の概要を簡潔に説明する部分です。研究の目的、方法、主な結果、結論を読者が素早く理解できるように要約します。
書くべきこと::
* 研究の目的と背景
* 使用した方法やアプローチ
* 主な研究結果
* 結論とその意義
注意点::
* 要約は簡潔であることが重要です。通常、150300語以内に収めるのが理想です。
* 結果と結論を簡潔に示すことが重要で、詳細なデータや図表を含めるべきではありません。

[dedication]
== Dedication(献辞)

目的:: 研究における支援を受けた人々や、研究のために特に感謝の意を示したい人物に対して捧げる言葉です。
書くべきこと::
* 感謝を述べるべき人々(指導教官、家族、研究チームなど)
* 特に研究活動において支援を受けた人物
注意点::
* 序文のように、感謝の気持ちを述べることに重点を置きますが、あまりにも長くなりすぎないように注意します。
* 一般的に、献辞は本論の内容とは無関係なので、簡潔に済ませます。

== Introduction(導入)

目的:: 研究の背景、問題提起、目的、意義、仮説、研究の範囲を説明します。読者が研究の文脈と目的を理解できるようにします。
書くべきこと::
* 研究問題とその背景
* 研究の目的と研究仮説
* 研究の意義や重要性
* 先行研究とそれらのギャップ
* 研究の目的や論文の構成(論文の全体像)
注意点::
* 導入部分では、明確な問題提起を行い、読者に研究の重要性を伝えることが大切です。
* あまり長くなりすぎないようにし、研究の目的と仮説に焦点を当てます。

== Methods(方法)

目的:: 研究に使用した手法、デザイン、データ収集方法、分析方法を説明し、研究の再現性を確保します。
書くべきこと::
* 研究デザイン(例: 実験研究、調査研究、ケーススタディなど)
* 参加者やサンプルの選定方法
* 使用した機器や材料
* 実施した手続きや方法論
* データ分析の手法や統計処理
注意点::
* 詳細かつ明確に記述し、他の研究者が同じ方法を再現できるようにします。
* 図表やフロー図を活用して、視覚的に理解しやすくすることも有効です。

== Results(結果)

目的:: 研究で得られたデータや結果を提示します。実験や調査の結果を示すだけで、解釈は含みません。
書くべきこと::
* 主な結果やデータの概要(定量的・定性的なデータ)
* 結果を示すための図表やグラフ
注意点::
* 結果だけに焦点を当て、データの解釈や議論はDiscussionに回します。
* データは簡潔かつ客観的に示し、不要な詳細は省きます。

== Discussion(考察)

目的:: 研究結果の解釈、意義、他の研究との関連、限界、今後の研究方向などを論じます。
書くべきこと::
* 結果の解釈とその意味
* 研究結果の理論的・実務的な意義
* 先行研究との比較とその違いや類似点
* 研究の限界や改善点
* 今後の研究の方向性
注意点::
* 結果を過大に解釈せず、限界にも触れることが重要です。
* 結果と一貫性を持って解釈し、研究の価値を適切に強調します。

== Conclusion(結論)

目的:: 研究の主要な結論を簡潔にまとめ、研究目的に対する回答を示します。
書くべきこと::
* 研究の主な結論
* 研究成果の要約
* 研究結果がどのように問題に答えるのか
注意点::
* 結論部分では、長々とした議論を避け、簡潔にまとめることが重要です。
* 新しい情報やデータを出さないようにします。

////
// 論文が長い場合のみ使用[index]に同じ。
// 略号が多い場合は特に有効。

[glossary]
== Glossary(用語集)

目的:: 論文内で使用した専門用語や略語の説明をまとめます。読者が理解しやすくするために使用します。
書くべきこと::
* 使用した専門用語や略語の定義
* 必要に応じて説明を加えます
注意点::
* 用語集は、読者が不明な点を確認できるように簡潔に整理します。

[glossary]
用語1::
	用語1の解説。

用語2::
	用語2の解説.

////

[bibliography]
== Bibliography(参考文献)

目的:: 研究で引用した文献や資料の一覧を提供します。
書くべきこと::
引用した文献の詳細(著者名、タイトル、発行年、出版元、巻号など)
注意点::
一貫した引用スタイル(APA、MLA、Chicagoなど)を採用し、正確に記載します。

[bibliography]
.Books
- [[[著者名1,年月]]] 著者名1, '書名1', 出版社1, ISBN No_1,
- [[[著者名2,年月]]] 著者名2, '書名2', 出版社2, ISBN No_2,

[appendix]
== Appendix(付録)

目的:: 研究の補足情報(詳細なデータ、コード、調査票、インタビュー内容など)を提供します。
書くべきこと::
* 研究で使用した詳細なデータや資料
* 実験結果の詳細な計算やコード
注意点::
* 付録に掲載する内容は、本論文に含めると冗長になるものや詳細すぎる情報に限ります。

////

// [index]は論文が長い場合のみ利用する。

[index]
== Example Index(索引)
////////////////////////////////////////////////////////////////
インデックスの内容はDocBookツールチェーンによって自動的に生成されます。
////////////////////////////////////////////////////////////////  

////

Wikiにしてがって目的や注意点も記載してみました。如何でしょうか。
「セクションのカスタムスタイル」を適宜配置して骨格として、そこそこの形になっていると思います。
次回からは此れを少し改良していきましょう。

取り敢えず今回はここまで。
…ではまた。

当Noteは下記の「AsciiDoc Language Documentation」の文法に従っています。


いいなと思ったら応援しよう!

この記事が参加している募集