ブログ記事を書いて、レビューして
エンジニアの皆さん、アウトプットしてますか?
今回はアウトプットの手段の中からブログにフォーカスをして、話をしていこうと思います。
実際に手を動かしたり、作ったりするような内容ではないので、学習の中での軽い息抜きのような感覚で目を通していただけたらと思います。
はじめに
こんにちは。クラウドソリューショングループのtakinami.sです。
皆さんはブログ記事を書くのは好きですか?
私は好きです。
この開発者ブログをできるだけ積極的に更新しようと努めているつもりですし、個人でも独自ドメインを取得してブログ運用を行っています。
昨年度からは主にレビュワーとしての活動にも取り組んでおり、ここ1年間で公開された記事のうち8割は何らかの形で私が関わっていると言っても過言ではないと思っています。(過言かもしれません)
何年間かブログ記事を書いてきた中で、自分なりに気をつけていることや信念のようなものが確立されてきたので、まとめてみようと思った次第です。
ブログを書くときに意識していること
では、さっそく私が意識していることをいくつかピックアップしていこうと思います。
「記録である」ということを意識する
ブログの語源が『ウェブ』+『ログ』というのは聞いたことがある方もいらっしゃるかもしれません。
あくまで『ログ=記録』なんですね。
記録で大事なのは、どんな過程を辿ってきてその結果何があったかです。
そのため、私はきちんと経緯を順序立てて書いていくことを大切にしています。
最初のうちは、「発信する習慣をつけることに重点を置いて人の役に立つ内容かどうかは気にしなくても良い」というのが私の持論ですが、経緯のわからない記事は後々自分が読んだ時にもよくわからない内容になっていることでしょう。
自分自身の経験をぜひ大切に記録してあげてください。
人に見られることを意識してレイアウトを考える
項目と項目の間の余白や、本文やタイトルなどのサイズは記事内で統一しておきましょう。
例えば私が作る記事では、目次に載せるような大きめの項目同士の間は3rem空けるというように自分の中でフォーマットを設けています。
あらかじめフォーマットを決めておけばそこに則って書いていくだけなので、毎回レイアウトを気にしながら書くという手間を省くことにも繋がります。
表記は公式に則る
例えば、主にフロントエンドで用いられる言語の「ジャバスクリプト」は、公式の表記では「JavaScript」です。
「javascript」と書いてももちろん伝わりはしますが、日頃から細かいところには気を使えていないのかなと私は感じます。(まさか「Java」なんて略していないですよね?)
大袈裟に感じるかもしれませんが、この人はきちんと取り上げている技術について理解しているのだろうかという疑問を抱くきっかけにもなってしまうと考えています。
ちなみにこれは採用の募集要項で使用技術などについて書かれている場合も同様です。
ほんの小さなことかもしれませんが、読者が信頼して読める記事を作りましょう。
国語の基礎を大切に
文章の表現を1つ例に挙げてみましょう。
物事を並行して進んでいることを表したり、さまざまな例を挙げたりするケースで用いられる「〜たり」という表現があります。
上の文のように「〜たり、〜たり」と2回以上用いるのが基本とされています。
こういった言い回しの他にも、句読点も意識すると良いでしょう。
しばしば、「ここに読点があると読みやすいのにな」、「1文が長いな」と感じる文章に出くわすことがあります。
読者にとって読みやすいリズムや、話の流れが少し変わるポイントに注意を払ってあげると、読みやすい句読点の入れ方ができると思います。
また、1文が3行以上(目安です)にもなるような場合は、思い切ってどこかで句点を入れることを意識してみてください。
適度に区切ることを意識することで、読みやすさだけでなく自分の中の考えをまとめることにつながるため、より良い文章づくりができるでしょう。
あえて、会話のような雰囲気を出すために文を崩すといった選択肢もあるので、この辺りは臨機応変に。
ブログ運営に関わってみた
自分のブログへのスタンスが確立できたところで、この開発者ブログの運営に関わるようにしました。
「社内ブログを発信の場として活用しよう」という動きが少しずつ社内で活発になってきており、それを加速させる側でありたいなと考えたためです。
関わる中でメリットが見えてきたので、少し紹介してみようと思います。
普段触らない技術の知識を得られる
レビュワーの基本的な取り組みとしては上で挙げたような、読みにくい文章はないか、表記ミスがないかといったチェックがメインになります。
ただ、私の場合はレビューする記事で取り上げられている技術のドキュメントに目を通すようにしています。
書かれている内容に間違いがないか確認するというのが1番の目的ではありますが、自分の知識の幅を広げるという副次的な目的も兼ねています。
普段はどうしても業務で関わりがある技術や自分がすごく興味を持っている技術に偏りがちなので、この動きは私にとって良い刺激を生むきっかけとなっています。
自分がブログを作っているんだという意識が生まれる
「なんだそんなことか」と思われるかもしれませんが、この意識がすごく大事だと私は考えています。
自分たちが作ってきたものに誇りを持つと同時に、より良くしていこうと次に向けた考えにつながるためです。
ブログに関わらず、自分が手がけたものに対して誇りを持つことは重要なことだと思うので、皆さんも活動を振り返ってみることから始めて次の動きへの活力にしてみては?
余談ですが、ブログ記事から問い合わせがくることもあり、関わっていて良かったなと感じることもできます。
最後に
「自分の経験や意見をどう発信しようかな、どうしたら伝わりやすくなるかな」といったことを試行錯誤しながら組み立てる、ある種パズルのような楽しさが記事作成にはあると私は捉えています。
最初は時間もとられるし面倒と感じるかもしれませんが、徐々に習慣づけていくことでアウトプットすることが自分の中で当たり前になり、記憶の定着や振り返りのしやすさにつながります。
もしかしたら、誰かの役に立ってなんらかのフィードバックがあるかもしれません。
こんな風に、1つの記事から始まる広がりを考えるとワクワクしてきませんか。