ゆみおの投稿 - Crieit

【連載】第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ショートカット」について掲載します！

【連載】第2回: その質問、報告、連絡、ＮＧです！あいまいな伝え方をしないコツ【新米エンジニアのためのマニュアル】

2021-04-12T21:17:06+09:00

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

第2回目は、質問や報告、連絡の仕方について掲載します。
新入社員にありがちなのが、あいまいな言葉で伝えてしまうことです。

私も注意されました…笑

本記事では、
1. 質問の仕方
2. 報告の仕方
3. 連絡の仕方

で困ったときに役立つコツを紹介していきます！

こんな質問、報告、連絡の仕方していませんか？

「あの、わからないんですが…」
「前に頼まれてたタスク、終わりました！」
「電車が遅れているため、遅刻します」

…残念ながら、こちらＮＧ100点満点の質問、報告、連絡の仕方です。

なぜＮＧなのか？

上記の質問、報告、連絡は情報不足だからです。
おそらく、相手からはこんな返答が返ってくるでしょう

「今少しお時間良いですか、これがわからないんですが…」
　→少しって何分？
　→今じゃないとダメ？
　→何がわからないの？

「前に頼まれてたタスク、終わりました！」
　→前に頼んでたタスクってなんだっけ？

「電車が遅れているため、遅刻します」
　→何分くらい遅れる？

情報が不足していると、不足している情報を確認しようと、
相手はヒアリングをしてきます。

会社のリーダーや上司なら、忙しい時間を割いて、あなたにヒアリングしてくるでしょう。

何がわからないのか、どんなタスクなのか、何分遅れるのか、
最初から具体的に伝えていれば、この無駄なやり取りを防ぐことができます

質問、報告、連絡をするときは、
無駄なヒアリングされないよう、
できるだけ具体的に、簡潔に、伝えるようにするのが
上手く質問、報告、連絡するコツです。

1. 質問の仕方

相手に質問をするときはまず、
質問しても良いか確認してから、
質問をするようにします。

まずは相手に時間があるのか確認しましょう

忙しい上司や先輩は、「今すぐ」質問に答えられる時間がない場合があります。
そのため、まずは質問に回答してもらえる時間があるのか確認しましょう。

この時、以下の情報が入っていることがポイントです！

要件は何なのか
いつから（今から/後で）
どのくらいの時間必要なのか

例えばこのような感じです

【要件は何なのか】
　〇〇さん、質問があるんですが

【いつから】
　今から

【どのくらいの時間が必要なのか】
　30分ほどお時間よろしいでしょうか

情報が十分なので、きっと相手からはこんな回答が返ってくるはずです。

「今大丈夫だよ、どうしたの？」
または
「今忙しいから、後でも良い？」

質問するときは、できるだけ「yes」または「no」の
２択で回答できるような質問の仕方を心がけましょう。

質問の承諾を得たら、質問しよう

質問の承諾を得たら、質問をします。
質問の場合は、以下の情報が入っていることがポイントです！

なんのプロジェクトの
なんの作業（タスク）で
何を聞きたいのか
どのようにしてほしいのか

を具体的にしましょう。

例えばこのような感じです

【なんのプロジェクトの】
　XXプロジェクトの

【何の作業（タスク）で】
　〇〇サーバのパラメータシートへパラメータ入力していたのですが、

【何を聞きたいのか】
　NTPのパラメータをどこに入力したら良いのかわからないので

【どのようにしてほしいのか】
　教えていただけないでしょうか。

2. 報告の仕方

直接報告する場合は、以下のような情報が入ってると良いでしょう

なんのプロジェクトの
なんの作業（タスク）が完了したのか
資料があればその格納場所
どのようにしてほしいのか

を具体的にしましょう。

例えばこのような感じです。

【何のプロジェクトの】
　 XXプロジェクトの

【何の作業（タスク）が完了したのか】
　〇〇サーバのパラメータシートへのパラメータ入力を終了いたしました。

【資料があればその格納場所はどこなのか】
　パラメータシートは××フォルダ（または具体的なパス）に格納しています。

【どのようにしてほしいのか】
　ご確認のほどよろしくお願いいたします。

3. 連絡の仕方

連絡はいろんなシチュエーションがあるため、
フォーマットが出せないのですが、

「５Ｗ１Ｈ」を意識して
誰が（Who）、日程や時間（When）、場所（Where）、
何を（What）、なぜ（Why）、どのように（How）が
明確になっていると相手に伝わりやすいですよ。

【例】
××電車が遅延しているため、30分出社が遅れます

〇月×日の10:00から進捗確認のミーティングをzoomで行います

10分前に△△社の〇〇さんから、××さん宛てに電話がありました。
電話番号を教えていただいたので、折り返しの電話をお願いいたします。

といった感じです。

誰が聞いても（読んでも）、
間違いなく誤解がないように伝わる文であるかを意識すると良いですよ

第2回はここまで。
第3回は「資料作成を頼まれたら、確認したいこと」について掲載します！

【連載】第1回: まずはこれ！新入社員が習慣化するべき行動５つ！【新米エンジニアのためのマニュアル】

2021-04-05T21:26:58+09:00

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

第1回目は、新入社員が習慣化するべき行動について掲載します！
誰だって入社してすぐは緊張して、何をすれば良いのか、パニックになりがち。

社会人になりたての時は右も左もわからず、オロオロ、キョドキョドしていた私…
ああ、あの頃の自分を、同じような人が新人を助けたい。。

そんな気持ちから記事を書いています。

本記事の内容は研修でも習った内容だと思いますが、おさらいしていきましょう！

1. 挨拶はコミュニケーションの基本

職場についたら「おはようございます」
先輩や上司とすれ違ったときに「お疲れ様です」
退社するときは「お先に失礼します。お疲れ様でした」

を言いましょう！
当たり前なんですが、ちゃんと理由があるんです。

人の第一印象は3秒で決まる

メラビアンの法則は聞いたことはありますか？

人の第一印象は3秒以内に決まり、
見た目などの視覚情報に影響を受ける割合が55％を占めると言われています。

笑顔で「おはようございます」と明るくあいさつしてくれる人
不愛想に「おはようございます」とぼそぼそあいさつする人

多くの人は前者に好印象を持つでしょう

挨拶することでコミュニケーションが円滑になる

挨拶はコミュニケーションの基本なので、
「挨拶ができない人」は残念ながら、「コミュニケーションができない人」と思われてしまいます…

挨拶から会話のきっかけが生まれたり、
話しかけやすい印象を相手に与えることができたりするので、
緊張していても、コミュ障でもまずはここを頑張りましょう！

挨拶してもらって、気分の悪い人はいません！
自信を持って挨拶しましょう〜！

2. メモを取ろう

ボールペンとメモ帳は　絶対　に持参し、常に持ち歩きましょう
絶対ですよ～！

会社の先輩や上司は忙しくしています
特にリーダークラスになると、
複数のプロジェクトを掛け持ちして、お客様と電話をしたり、打合せをしたり
1日中忙しなく動いていることも少なくありません

先輩や上司はあなたの質問に答えるために、
忙しい中、時間を割いてくれます。
そんな先輩や上司に、何度も何度も同じ質問をするとどうでしょうか？

優しかった先輩や上司が、優しくなくなってしまうかもしれません…

もう一度、聞かないために

一度聞いたことは、
もう一度聞かなくても良いようにメモを取るように習慣付けましょう

また、アウトプットすることで記憶の定着や理解が深まります
時間がある場合は、メモ帳やexcelなどで資料を作成してみても良いでしょう

とにかくメモ魔になりましょう！

ちゃんと、自分の読める字でね笑

3. 職場の人の名前や顔、ルールを覚えよう

入社して最初は書類の記入や研修。
先輩たちも教えるプロではないので、
空き時間が発生することもあると思います。

そんなとき、空いている時間に勉強するのも良いですが、
事務所の代表、部長、課長、係長やチームリーダー、教育担当者、
同じ部署や同期、チームの人の名前を覚えましょう

席の場所なども覚えておくのも良いでしょう

案内はされると思いますが、
トイレの場所を確認したり、会議室の場所、喫煙場所、休憩スペース、
自動販売機の場所、会社を休む時は誰に連絡をすれば良いのか、など

自分の働く環境について理解を深めていくと
安心して緊張や不安も少し減ります

4. 困ったときに頼る先輩や連絡方法を確認しよう

誰が自分の教育係の先輩や上司なのか把握しましょう

また、先輩や上司が職場に不在の時、打合せで席を外している時に、
連絡の取れる方法（電話番号やメールアドレス）や、
他にどの先輩に質問しても良いのか確認しておきましょう。

困ったときに誰を頼れば良いのか、明確になっていると安心 ですね

5. 報連相できるようになろう

研修でも耳が痛いほど聞いていると思うのですが
「報・連・相」すなわち、「報告」「連絡」「相談」とても大事です！！

依頼された仕事、タスクの進捗状況を　「報告」
依頼された仕事、タスクが終わったら　「報告」
会社を休む、遅刻するときは　「連絡」
誰かが先輩を探していたなど伝言があれば　「連絡」
仕事でわからないことがあれば先輩に　「相談」
困ったら先輩に　「相談」

など…

話しかけられるまで待つのはNGです

入社したては何もできないのが当たり前ですが、
できるだけ早めに「報・連・相」できるように実践しましょう
話しかけるにが苦手なら、チャットでもメールでもとりあえず良いです

いつまでもできないままだと「できないやつ」と思われるのは正直時間の問題です…

円滑に仕事を進めるためにも、
しっかり「報・連・相」を実行していきましょう

第1回はここまで。
第2回は「質問、報告、連絡の仕方」について掲載します！

【RHEL / vROps】rsyslogでvROpsからログを受信する際にFraming Errorメッセージが大量に出力される【解決】

2021-03-30T21:29:49+09:00

vROps（VMware vRealize Operations）のログを
rsyslogで受信する設定をした際に、
/var/log/messagesにFraming Errorメッセージが大量に出力される現象が発生したため、メモ

動作環境

Red Hat Enterprise Linux 8.3 (Ootpa)
Kernel: 4.18.0-240.el8.x86_64
rsyslogd 8.1911.0-6.el8

Framing Errorメッセージ

Mar 25 11:21:41 servername rsyslogd[1511]: imtcp imtcp: Framing Error in received TCP message from peer: (hostname) vROpsserver, (ip) vROpsserver: delimiter is not SP but has ASCII value 10. [v8.1911.0-6.el8]
Mar 25 11:21:41 servername rsyslogd[1511]: imtcp imtcp: Framing Error in received TCP message from peer: (hostname) vROpsserver, (ip) vROpsserver: delimiter is not SP but has ASCII value 45. [v8.1911.0-6.el8]
Mar 25 11:21:41 servername rsyslogd[1511]: imtcp imtcp: Framing Error in received TCP message from peer: (hostname) vROpsserver, (ip) vROpsserver: delimiter is not SP but has ASCII value 58. [v8.1911.0-6.el8]
Mar 25 11:21:41 servername rsyslogd[1511]: imtcp imtcp: Framing Error in received TCP message from peer: (hostname) vROpsserver, (ip) vROpsserver: delimiter is not SP but has ASCII value 62. [v8.1911.0-6.el8]

Valueの数値は、10,45,58,62の4種類かな？
メッセージが大量に出力されるため、/var/log/messagesがこのメッセージで埋まってしまう…

【Framing Errorメッセージについて】
rsyslogdが受信したメッセージの形式が不正であった場合に出力されるメッセージで
メッセージ区切り文字が SP（space）ではなく ASCII 文字の value [xx] として受信したことを意味しているようです。

vROpsがoctet-counted framingを採用していることが原因

vROpsがoctet-counted framingを採用していることによるエラーとのことなので
syslogサーバでOctetCountedFramingをオフにすればOK

対応

rsyslog設定ファイルに、OctetCountedFramingを無効にする設定をする

# vi /etc/rsyslog.conf

## 修正前
module(load="imtcp") # needs to be done just once
input(type="imtcp" port="514")

## 修正後
module(load="imtcp") # needs to be done just once
input(type="imtcp" port="514" supportOctetCountedFraming="off")

rsyslogd再起動で設定を反映

# systemctl restart rsyslog

【RHEL】crontabにlogrotateコマンドを登録したのに実行されなかった【解決】

2021-03-26T21:32:33+09:00

カスタムで作ったログローテ設定ファイルを読み込んで
任意の時間でログローテーションしたくて

crontab -e（/var/spool/cron/root）に
logrotateコマンドを登録したら実行されなかったのでメモ

結果的には、logrotateコマンドをフルパスで指定することで解決しました。

動作環境

Red Hat Enterprise Linux 8.3 (Ootpa)
Kernel: 4.18.0-240.el8.x86_64
logrotate 3.14.0

cron設定

以下の設定でlogrotateコマンドをcrontabに登録

# crontab -l
0 1 * * * logrotate -f /root/rsyslog_custom.conf

したけど、なんだか動作してないっぽい

ログ確認

とりあえずログを確認

# tail /var/log/cron
Mar 26 10:55:01 servername CROND[86361]: (root) CMD (logrotate -f /root/rsyslog_custom.conf)
Mar 26 10:55:01 servername CROND[86338]: (root) CMDOUT (/bin/sh: logrotate: コマンドが見つかりません)

コマンドが見つからない？なんで？？

原因

調べてみたら、ログイン時に読み込まれる環境変数と
cron実行時に読み込まれている環境変数が異なるから、とのこと。

なるほど、PATHの変数の内容が違うのかな？

検証

試しにcron実行されるときのPATHを確認

# crontab -e
0 1 * * * logrotate -f /root/rsyslog_custom.conf
## PATH変数を出力するコマンドを登録
0 11 * * * echo $PATH > /tmp/path.txt

cron実行される時のPATH

# cat /tmp/path.txt
/usr/bin:/bin

rootログイン時のPATH

# echo $PATH
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/root/bin

logrotateコマンドのフルパス

# which logrotate
/usr/sbin/logrotate

なるほど、cron実行時のPATHに/usr/sbinがないから
そりゃ実行できないよね…

対応

フルパス指定でcron登録を修正

# crontab -l
0 1 * * * /usr/sbin/logrotate -f /root/rsyslog_custom.conf

実行されているか確認

# tail /var/log/cron
Mar 26 11:06:01 servername CROND[86677]: (root) CMD (/usr/sbin/logrotate -f /root/rsyslog_custom.conf)

動いた！

cronって今までシェルスクリプトの登録くらいしかしてなかったから
環境変数違うなんて気がつかなかったな…笑

現役サーバエンジニアしてる私の話【自己紹介】

2021-03-24T21:41:25+09:00

はじめまして、ゆみおです！
サーバエンジニア歴7年ほどで、ずっとやってみたかった技術ブログに手をつけました。
技術記事を投稿していく前に、自己紹介を書こうと思った次第です。

【本記事の内容はこんなかんじです】
* どんな人か
* サーバエンジニアになるまでの経緯
* どうして技術ブログを始めようと思ったのか
* 書こうと思っている記事の内容

どんな人か

サーバエンジニア歴7年
（RHEL、Windows、ESXi、シェルスクリプトなど）
一児の母（育休復帰済）
ゲームと音楽が好き
時々ゲーム実況配信、投稿
めんどくさがり

こんな感じです！

サーバエンジニアになるまでの経緯

大学は芸術大学に通っていました。
就活はちょうどリーマンショックが起こり、就職氷河期と言われていた頃。
就活をナメになめていた私は当然就職できるはずもなく、
卒業後、1年半ほどはフリーターをしていました…笑

ライブハウスの依頼でフライヤーやCDジャケット作ったり、
スーパーでパート勤務して、友達の伝手でWeb制作のバイトをして。
親からさすがに「そろそろ就職しろ」、と言われてWeb制作してた会社で社員になります。

が、Web制作だけでは正社員に払えるようなお金が会社に入らないとのことで、
サーバエンジニアのドキュメント作成要員として客先常駐の仕事をすることになりました。

そこの常駐先のお客さんがとても良い人で私をサーバエンジニアとして育ててくれました。
それから別の会社に転職して今に至る感じです。

どうして技術ブログを始めようと思ったのか

ずばり、承認欲求が私を動かしました！笑
大人になると誰も褒めてくれないの！笑
褒められたいし感謝されたいんだ、「いいね！」くれ！！！笑

でもずっと書きたいなあとは思ってたんです。
自分の性格上、仕事で学んだことや情報のメモを付けることが習慣になっていて、
でも何回かそのメモを参考にしても、フォルダの奥底に眠ってしまうことが多くて、
情報共有すれば、助かる人がいるかもしれないのに、もったいないなあって。

ドキュメント書くのは好きだし、
他人に教えるの好きだし、
他人に伝わりやすい書き方の勉強にもなるし、
アウトプットすることで、自分の頭に定着しやすいし、
もしかしたら収益化できるかもしれないし←

メリットしかないじゃん！！ってなったわけです。

書こうと思っている記事の内容

書こうかなと思ってる記事の内容はこんな感じです。
* 初心者向け、IT基本講座
* 初心者向け、Excel、Word、PowerPointを使った資料作成講座
* RedHat Enterprise Server（CentOS）の構築手順
* ミドルウェアの構築手順（Zabbix、Oracleなど）
* 便利そうなシェルスクリプトの公開
* Macbook AirでSwitchゲーム配信する手順

主に仕事で関わる部分だったり、趣味の範囲だったりです。

以上です。
まだ記事は書いてませんが期待を込めて
「いいね！」や「フォロー」してくださるととても嬉しいです！