【連載】第3回: ドキュメント作成を頼まれたら！確認したい４つのポイント【新米エンジニアのためのマニュアル】

2021-04-19T22:01:41+09:00

こんにちは、ゆみおです！
本シリーズの内容は、新米エンジニアに向けた応援企画の記事です。

第3回目は、ドキュメント作成を頼まれたら、確認したいことについて掲載します。

エンジニアという職業は、
ひたすらアプリケーションを開発したり、
黒い画面に英語ばかりの画面と向き合っている職業だと思われがちですが、

実際には、打合せをした際の議事録や進捗管理表、
システムの設計書、試験仕様書、運用マニュアルなどなど、
たくさんのドキュメント（資料）を作成する作業が発生します。

むしろ、私はドキュメントを作成している時間のほうが多いです…
（仕事の担当にもよるのでしょうが…）

ドキュメントにはたくさんの種類がありますが、
「ドキュメントを作成して」と言われた際に、
必ず確認すべきポイントは以下の４つです。

1. 誰向けのドキュメントなのか確認する（文章レベル感の確認）
2. フォーマット（ひな形）や参考になる資料などはあるか確認する
3. 印刷する資料なのか確認する
4. 作成する期限はいつなのか確認する

1. 誰向けのドキュメントなのかを確認しよう

仕事においては色んな用途のドキュメントが存在しますが、
「誰向けのドキュメントなのか」という点においては、
以下の３種類に分かれます。

1.1. 自分向けのドキュメント
1.2. 社内向けのドキュメント
1.3. エンドユーザ向けのドキュメント

1.1. 自分向けのドキュメント

自分向けのドキュメントはとりあえず、
「自分が読めれば、理解できれば良いドキュメント」です。

自分用のメモだったりがこれに当てはまります。

逆に言うと、自分さえ読めれば良いので、

他人に見せるようなものではないドキュメントです

また、ドキュメント作成で自分向けのドキュメントを作成して、
と言われることはありません。

1.2. 社内向けのドキュメント

社内向けのドキュメントは、
「社内の人、プロジェクトメンバーの間で読んで理解できれば良いドキュメント」です。

進捗管理表だったり、社内の打合せの議事録だったり。

社内向けは多少文章が雑でもOK
社内の雰囲気にもよるが時にはジョークを混ぜたりしてもOK。

ただし、読む人が理解できるように文章を書く必要はあります。
新人の頃は、社内向けの議事録を記録するように依頼されることも多いでしょう。

1.3. エンドユーザ向けのドキュメント

エンドユーザ向けのドキュメントは、
「エンドユーザが読んで理解できるドキュメント」です。

これにあたるのは、エンドユーザとの打合せの議事録だったり、
納品物となる、要件定義書や設計書、試験仕様書、運用マニュアルになります。

エンドユーザ、つまりプロジェクトのお客様が読むものなので、
「会社の信用に関わる重要なドキュメント」です。

なので、
* きちんとした文章使い、
* 読みさすさ、
* 見た目の美しさ（罫線や文字の統一性など）

が求められます。

新人さんが関わるドキュメントは、
パラメータシートや、試験仕様書、運用マニュアルなどの修正や設定値入力でしょう。

最初のうちはわからないと思うので、

作成するドキュメントは誰向けのものなのか逐一確認して
どの資料が社内向けなのか、エンドユーザ向けなのか理解していきましょう。

2. フォーマット（ひな形）や参考になる資料などはあるか確認する

ドキュメント作成には大体、
この資料が参考になる、とかフォーマット（ひな形）が存在します。

ドキュメント作成を依頼された際に、

どんなドキュメントを作成すれば良いのか完成系が見えない場合は、
フォーマットや参考になる資料がないか確認をしましょう。

フォーマットがもらえれば、大体どの形式で作成すれば良いかわかるものですが、
もし作成するドキュメントの形式の指定がなかった場合は、
Excel、Word、PowerPoint、メモのどれで作成すれば良いのか確認をしましょう。

3. 印刷する資料なのか確認する

作成するドキュメントが印刷するものなのか、しないものかも確認をしましょう。

印刷するドキュメントだった場合、
印刷設定や改ページ、ヘッター、フッター、ページ番号などの設定が必要になる場合があります。

もし、印刷設定が必要な場合は以下のポイントについて確認をしましょう。

ページサイズの設定（A4縦なのか横なのか）
ヘッター設定、フッター設定
ページ数の設定

また、実際に印刷を頼まれた場合は、
* 1枚あたりに何ページ印刷するのか
* 片面印刷か両面印刷か
* 白黒印刷かカラー印刷か

を確認すると良いでしょう

4. 作成する期限はいつなのか確認する

ドキュメント作成に限りませんが、
タスクを依頼された場合は、

必ずいつまでにそのタスクを終らせないといけないのか、確認をしましょう

また、タスクが完了したら速やかに
タスク完了の報告をしましょう

以上、「ドキュメントを作成して」と言われた際に、
必ず確認すべきポイントは以下の４つでした！

ドキュメント作成は何度も作成していると、
なんとなくこれは社内、エンドユーザ向けだな、
印刷するな、あればフォーマットかな？参考になるかな、とあたりがついてきます。

場数を踏めば、確認することも減っていきますが、

最初のうちはなかなかわからないと思うので、
この４つのポイントを確認して、
少しずつ、覚えていきましょう！

第3回はここまで。
第4回は「覚えておくと良い、Windowsショートカット」について掲載します！

「ドキュメント作成」の記事 - Crieit