【学問のすすめ】中世ヨーロッパ写字生のように黙って静かに手を動かすブログ

これまで習ったことや学んだことを記事にまとめています。ITネタが多いです。

【AIIT】PBL活動におけるドキュメント作成規則の例

AIIT(産業技術大学院大学)のPBL活動で作ったドキュメント作成規則を紹介します。

PBL活動では、チームでかなりの数のドキュメントを作成します。 メンバー間でドキュメントの書式や構成を統一する必要があり、基本的には教員の指示に従います。
今回は、2019年に私達が作ったドキュメント作成規則(書式設定)を紹介します。

 

所属PBL

私が参加したPBL(研究室)は以下です。

 

フォントについて

使用できるフォントの種類

ドキュメントにおいて使用できるフォントの種類は以下の2種類とする

  • MS P ゴシック
  • MS P 明朝

 

フォントの設定

  • 表示のタイトル部分
    • フォント:MS P ゴシック
    • サイズ:24ポイント
  • 表紙の日付部分
    • フォント:MS P ゴシック
    • サイズ:22ポイント
  • 文書管理番号 (ヘッダーにつける文書番号)
    • フォント:MS P 明朝
    • サイズ:10ポイント
  • 目次のタイトル:目次
    • フォント:MS P ゴシック
    • サイズ:14ポイント
  • 目次部分
    • フォント:MS P ゴシック
    • サイズ:11ポイント
  • ページ番号
    • フォント:MS P ゴシック
    • サイズ:10.5ポイント
  • レベル1タイトル(見出し1)
    • フォント:MS P ゴシック
    • サイズ:12ポイント
  • レベル2タイトル(見出し2)
    • フォント:MS P ゴシック
    • サイズ:11ポイント
  • 本文
    • フォント:MS P 明朝
    • サイズ:11ポイント
  • 図表番号
    • フォント:MS P ゴシック
    • サイズ:11ポイント
    • フォント設定:太字
  • 表全体
    • フォント:MS P ゴシック
    • サイズ:11ポイント
  • 表の項目名部分 -フォント:MS P ゴシック
    • サイズ:11ポイント
    • フォント設定:太字 参考文献
    • フォント:MS P 明朝
    • サイズ:11ポイント

 

ページ設定および構成

用紙設定

  • 用紙:A4縦
  • 余白:上下左右 20mm
  • ページ番号
    • 位置:フッター中央
    • スタイル:1,2,3
    • 適用範囲:ページ全体
  • ページ区切り
    • 見出し1の項番が変わるごとにページ区切りを実施
  • ヘッダー
    • 左上部分に文書管理番号を入力する

 

ページ構成

  • 表紙
  • 改訂履歴
  • 目次
  • 本文
  • 参考文献
  • 付録

 

ページごとの設定

  • 表紙
    • スタイル「本文」で入力
  • 改訂履歴
    • 上述「表の書式」に従う
  • 目次
    • 目次挿入機能を使用して作成
  • 本文
    • スタイル「見出し1」「見出し2」「見出し3」を使用して章立てをする
    • 章番号には「段落番号」機能を使用する
    • 図表番号/段落番号を指定する際は必ず「相互参照」を使用する
  • 参考文献
    • 「参考文献」機能を使用する。詳細は後述。

 

参考文献

  • 参考文献機能を使用する
    • 書式:IEEE
    • 文中には「挿入」メニューから参考文献の番号を入力する
    • 文末に「参考文献」の独立したページを用意する
    • 参考文献表は「参考文献」機能による自動生成を行う

IEEE方式の記述方法について詳しくは以下を参照してください。(英語なのでかなり戸惑いますが、他によい資料がありません)

IEEE Editorial Style Manual
https://journals.ieeeauthorcenter.ieee.org/your-role-in-article-production/ieee-editorial-style-manual/

journals.ieeeauthorcenter.ieee.org

 

その他注意事項

文章の構成について

基本的な考え方は「理科系のための作文技術」に従う。以下には特に注意する。

  • 体言止めで記述する
  • 前段までで説明されていない要素を使わない
  • 参考文献はすべて最後に記載する

句読点について(予稿作成時)

  • 読点「、」は「,」(全角カンマ)を用いる
  • 句点「。」は「.」(全角ピリオド)を用いる

 

句読点について(PBL内ドキュメント作成時)

  • 読点「、」はそのまま「、」を用いる
  • 句点「。」はそのまま「。」を用いる

 

提出時の注意

  • 目次は自動生成ではなくテキストに書き換える
  • 校閲機能により挿入されたコメント/改訂履歴はすべて削除する
  • 中間成果物の段階ではコメント/改訂履歴を削除する必要はない
  • 1回目の改訂箇所は黄色マーカーで示す
  • 2回目の改訂箇所は水色マーカーで示す
  • 削除した箇所は取り消し線で示す
  • コメントは 括弧 < > 内に入力する

 

レビューに関して

  • レビューは必ず印刷物で行う
  • モニター画面でレビューした場合問題を見落とす可能性が高くなる
  • レビューは必ず複数人で行う
  • 自身でレビューする場合は必ず編集後24時間以上後で行う

 

補足

規則の管理について

このドキュメント作成規則は、WORDで書くときの一般的な設定に教員から指示された設定を加えて作りました。 PBL(研究室)で使用するプロジェクト管理ツールのWikiページに掲載し、更新があるごとに書き換えて使います。
注:書式の設定はPBL(研究室)ごとに異なる可能性があり、確認が必要です。

 

ドキュメント作成について

実際にドキュメントを作成する際には、ドキュメント作成規則を反映したテンプレートファイル(DOTXファイル)を使います。
テンプレートファイルは、WORDファイルに「スタイル」「ページ設定」などに書式を設定、ファイルをDOTX形式で保存することで作成できます。 作ったファイルをGoogle Driveに保存、メンバー全員がこれを利用することでファイル作成ごとに書式を変更する手間を省きました。

 

感想

ここまでやるのは本当に大変でした。