Bullet Group Advent Calendar 2020 2日目の記事です。
2日目はusekが担当します。私の記事が取り上げるのはITテクノロジーではありませんが、ちゃんと技術について語ります。
この記事を書いた動機
この記事は先月本ブログで公開された私の書いた記事になります。ネタバレになりますが、この記事は元々数ヶ月前に書き上げていました。 正式公開前に再度推敲しましたが、それでも「文章量が長すぎる。話も散らかっていて読みにくい」と自分で感じていました。 しかし自分では読みづらいと分かっていても、書き直す技術を持っていませんでした。
ちょうどこの頃、弊社で大学生がインターンで働き始めました。彼の書く文章が分かりやすかったためそのコツを聞いたところ、
”分かりやすい文章を書くには法則があります”
とドヤ顔で表題の書籍を紹介してもらいました。
この本を読んで非常に感銘を受けました。「この本に書かれているテクニックを使えば、自分の過去書いたブログ記事が読みやすくなるのではないか」と考え、再度記事の推敲に挑戦することとしました。
書く技術・伝える技術とは
この本の主張は、書き方には「技術」があるということ。 私は日本語の文法は学校で学んできましたが、「文章の書き方」を学んだことはありませんでした。 この本には、欧米では学校教育で1年かけて学ぶライティングのスキルが紹介されています。 読み始めて数ページ、さっそく目から鱗が落ちた記述がありました。以下に引用します。
「文章には、大きく分けて、楽しみのための文章とビジネスのための文章の2種類があります」 楽しみのための文章とは、内容を味わうために、読み手が進んで全てを読む文章です。(中略)一方、ビジネスのための文章とは、情報を伝達し合うために、読み手が仕方なく必要な部分だけを読む文章です。(中略)読み手が、情報入手のために仕方なく読む以上、書き手は、読み手に負担をかけない文章を書かなければなりません。
私はこれまで特に規約・ルールを設けず、思うがままに文章を書いていました。「読み手に負担をかけない文章」のような考えは思い浮かんだこともありませんでした(笑)
この本の文章は当然”書く技術・伝える技術”を用いて書かれています。そのため、非常に論理的で、結果的に読みやすい文章になっています。 実際に私がこの本を読む前に書いたブログ記事の導入と、技術を意識して書いたブログ記事を皆さんに比較していただきたいです。
実践
書く技術・伝える技術を使用せずに書いた文章
まずは先ほど紹介した私の記事の序文を以下に引用します。
私のミッションとしてバレットグループが提供しているサービス群を堅牢にするというものがあります。 特にバレットグループが自社サービスで多用しているAWSにおけるセキュリティ強化は重要です。 攻撃や障害によるサービスへの影響を防ぎ、発生した場合も素早く検知、対応するよう体制を整えなければなりません。
AWSには膨大なサービスがあり、使ったことはおろか聞いたこともないサービスも多々ありますが、セキュリティに関しても多くのサービス・機能が用意されています。 中には効果が重複しているものもあり、どのサービスを導入するかは時間対効果・費用対効果を検討するべきです。 組織の特性は組織の数だけあり、ある組織にとって有効な施策も別の組織にとってはそれほどでもない、というパターンも当然あります。
今回は私の作成したバレットグループ向けセキュリティガイドラインで定義されているAWS上のサービスを紹介します。 AWSのセキュリティ対応を検討されている方の参考になれば幸いです。
書く技術・伝える技術を使用して書いた文章
この文章を改めて以下のように書き直しました。
私のミッション
SREチームに所属する私の現在のミッションは、バレットグループが提供しているサービス群を堅牢にすることです。
特に自社サービスで多用しているAWSにおけるセキュリティ強化は重要です。攻撃や障害によるサービスへの影響を防ぎ、万が一インシデントが発生した場合も迅速に対応する必要があります。 同時に、開発や運用の操作を安全に行えるようにすることで、ヒューマンエラーによるインシデントを防ぐ方法も採用したいです。
上記2点を実現するために、SREチームがAWSを利用する際に参照する”セキュリティガイドライン”を作成しました。
セキュリティガイドラインとは
AWSにはサービスのセキュリティを強化したり、不正なアクセス・異常な振る舞いをリアルタイムで検知、通知するサービスが多数用意されています。 一方で後から追加されたサービスが従来のサービスと効果が重複している場合もあります。弊社アカウントの状況からは過剰ともいえるサービスも存在しました。やみくもに導入する意味は薄いです。 導入の難易度、発生する費用、得られる効果を検討し、弊社に適したサービスの利用について記したものが「セキュリティガイドライン」です。
セキュリティガイドラインを導入する利点
セキュリティガイドラインを設けることで、以下のような効果が期待されます。
ガイドラインに従って各サービスを利用・設定することで、属人性を廃し、複数アカウントの状態を統一することができます。
検討されたガイドラインを採用することで、AWSに詳しくない人でも堅牢かつ利用しやすいアカウントを作成運用することができます。
ガイドラインを導入したことで、これまでアカウントごと個人ごと設定していたリソースの設定や名称、監視する項目、セキュリティ対応策などが統一されました。 各サービスも視覚的に何の目的で利用されているかがも分かりやすくなり、結果利便性が改善されました。
弊社ガイドラインには「セキュリティ強化」「開発・運用品質改善」「インシデント対応の迅速化」に加えて、「コストをチェック・削減」の4つの目的を達成するため、利用を推奨するAWS上のサービスが定義されています。 今回私が紹介するセキュリティガイドラインがAWSのセキュリティ対応を検討されている方の参考になれば幸いです。
結果
推敲により以下のように文章が改善されました。
文章の過不足がなくなった
推敲前の文章は
私のミッションとしてバレットグループが提供しているサービス群を堅牢にするというものがあります。
と書き出しましたが、まず「私」の説明が不足しているため読み手は「お前は何者なのだ」と思ってしまいます。 そのため
SREチームに所属する
を追加して背景を明示しました。
また、推敲後の文章には以下が追記されています。
同時に、開発や運用の操作を安全に行えるようにすることで、ヒューマンエラーによるインシデントを防ぐ方法も採用したいです。
や
加えて、「コストをチェック・削減」の4つの目的を達成するため、利用を推奨するAWS上のサービスが定義されています。
これらが追記された理由は、先月私の書いた記事で紹介されていたAWSのサービスはセキュリティとインシデント対応向け以外のサービスも列挙されていました。 見出しにもある「1. コストをチェックし、削減する」「3. 誤操作を防ぐ」に関するサービスです。 しかし序文にはこの目的の記載がありませんでした。総論に無い内容を列挙していたため、読む側にとっては唐突な印象を与えてしまうものでした。
また、逆の問題点があります。
AWSには膨大なサービスがあり、使ったことはおろか聞いたこともないサービスも多々ありますが
や
組織の特性は組織の数だけあり、ある組織にとって有効な施策も別の組織にとってはそれほどでもない、というパターンも当然あります。
などは書く必要のない記載です。明らかに分かっていることを書くことで読む側の時間を使わせてしまいます。 しかし、これを削ると「AWSのサービスから必要なガイドラインを取捨選択した」というプロセスの説明が消えてしまいます。 (そもそも、それを説明する目的で上述した文章を書いたのか、と指摘されてしまいそうですがw) そのため、以下の文章を追加しました。
一方で後から追加されたサービスが従来のサービスと効果が重複している場合もあります。弊社アカウントの状況からは過剰ともいえるサービスも存在しました。
この事実を基に、どのサービスを導入するか、時間対効果・費用対効果を検討したことを記述しました。
文章が整理された
推敲後の文章で真っ先に気がつく点は”表題”がついていることだと思います。 元々の文章は行数としてはたったの4行でしたが、その中に「自分の役割」「対応策」の2つが区切りなく記載されていて、私自身も読んでいて分かりにくかったです。 そのため表題を分け、表題に関係あることのみ記載することで文章にメリハリを付けました。 また、各表題は繋がりがあります。
- 「私のミッションを達成するためにガイドラインを作った」
↓ - 「ガイドラインとはバレットグループ向けに利用を推奨しているサービスのことである」
↓ - 「ガイドラインを導入する結果私のミッションを達成できる」
の流れができています。このことにより「読み手に負担をかけない文章」の効果が生まれます。
まとめ
書く技術・伝える技術を使用して書いた記事にどのような感想を持たれましたか? 文章は長くなってしまいましたが、推敲前と比べて、セキュリティガイドライン作成の動機や、ガイドラインの内容が理解しやすくなったはずです。 今回紹介した「書く技術・伝える技術」 には他にも文章の品質を改善する手法や考え方が実践を含めて紹介されています。是非読んでみてください。
私も「書く技術・伝える技術」を学んだばかりの初学者です。手元にある本を読みながら何度も書き直して上記の文章を作成しましたが、まだ法則通りには書けていないと思います。 読み手に負担をかけない分かりやすい文章を書く技術を引き続き身につけていきたいです。