0
0

More than 1 year has passed since last update.

記事を書く目的と構成について

Posted at

記事を書く目的

目的は、2つあります。

<1つ目>
 自分が作業で学んだ内容の整理と理屈を確認すること。

<2つ目>
 新人エンジニアが記事を読んで何かの手助けになること

1つ目の目的について

1つ目については、教えてもらった内容や学んだ内容を自分で解釈し、
どのような理屈(仕組み)になっているかを理解したいと思い、設定しました。

作業をしていて、どのように進めてよいか分からなかった内容を教えてもらうことがありましたが、理屈を教えてもらえず、修正方法や記載内容など。「答え」だけを教えてもらうことが多く、なぜその「答え」になるか分からない場面が多くありました。

また、1~2年目で知識がない中説明を受け、「何を言っているんだろう・・」状態になり、説明された内容のついていけない、何が分からないか分からない状態になり、整理ができないことがよくありました。

「答え」を出すための理屈を理解する「解釈する場」や教えてもらった内容の「整理をする場」として記事を書き、エンジニアとして必要な知識を蓄えたいと考え、目的を設定しました。

2つ目の目的について

2つ目については、知識があまりない新人エンジニアという弱い立場の方の役に立てれればと思い、設定しました。

知識がなく右も左も分からない中、何を聞いて作業を進めてよいか、作業で困ったことをどのように(ツールやエディタなど使って)解決するか分からないことが多くあると思います。

新人が疑問に思うことや分からないことを何とか解釈した内容を質問すると、「当たり前のことなんで聞くの」、「馬鹿だろ」など理不尽に責め立てられてしまい、理不尽に壊されてしまうことがあることをよく聞きます。

自分としては、
「仕事ができる(裁量権がある)からといって人を壊してよい」
ことは間違っていると強く思っています。

弱い立場のエンジニアを理不尽に壊されないよう、何か手助けになれればと考え記事を残してみようと思いました。

記事の構成について

記事を次のような構成で作成していこうと考えています。

<記事構成>
 1、事象について
 2、教えてもらった内容
 3、教えてもらった内容の補足や調べた内容
 4、実際の使用方法

1、事象について

どのようなことで困ったのか、問題が起きたのかをイメージしやすくすることを目的として記載します。

2、教えてもらった内容

教えてもらった内容をそのまま記載します。

3、教えてもらった内容の補足や調べた内容

「2、教えてもらった内容」から、内容を解釈するのに、どのように解釈したか、どのように調べたかを記載して、自分がどう整理したかを思い出せることを目的として記載します。

4、実際の使用方法や使用のされ方

作業イメージや解釈イメージを湧かせやすいことを目的として記載します。
キャプチャーや図などを使用して、内容をまとめたいと考えています。

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0