エンジニアHubPowered by エン転職

若手Webエンジニアのための情報メディア

エンジニア向けライティング講座。見落としやすい注意ポイントを徹底解説!

個人が趣味で運営するサイトと、企業が事業として提供するサービスでは、責任の大きさが違います。守るべき法律やライセンスがあり、モラルが厳しく問われるだけでなく、掲載する情報の正確さ、分かりやすさに気を配ることも大切です。開発を業務とするときに、エンジニアリング以外でどんなことに気をつけるべきでしょうか。

ライティング講座

こんにちは、Webエンジニアとして企業に勤めている池田@ikenyalです。
この記事では、サービス開発を業務とするエンジニアが、作成したプロダクトや提供する企業の価値を低下させないために、エンジニアリング以外の部分で心がけたいポイントについて紹介します。

個人が趣味で公開しているWebサイトと、企業などが事業として提供するWebサイトでは何が違うのでしょうか? 一番の違いは、責任の大きさだと思います。個人のサイトにももちろん責任は伴いますが、事業として提供するサービスやプロダクトとなれば、より大きな責任を負わなければならないことは明白でしょう。

間違いがあったときに担当者が謝罪すればそれでいいというわけにはいかず、問題の大きさによっては所属する企業そのものの責任が問われる場合もあります。開発・運営するスタッフの少しの気の緩みで、企業が社会的な信用を失い、サービスやWebサイトを閉鎖し、経営トップが謝罪するような危機に追いやられてしまうことだってあり得ます。

それは極端な例としても、ちょっとしたことで「このサービス大丈夫かな?」と不安に感じた経験は皆さんにもあるのではないでしょうか。これから説明することに少し気をつけるだけで、そのような「ちょっとした不信感」を避けられるでしょう。

「このサービス大丈夫かな?」と感じるのはなぜだろう

まずは「このサービス大丈夫かな?」と感じる要因について考えてみます。

サイトで404などのエラーが起きていたりバグだらけだというのは言語道断ですし、それはエンジニアリングの問題なのでここでは触れません。サービスやプロダクトとしては利用できるものの「いまいち信用できないな」と感じさせてしまうようなことに焦点を当てていきます。

企業やサービスに不信感を抱く状況には、例えば以下のようなものがあるでしょう。

  • 法律・モラル・ライセンス・規約などに反する内容がある
  • 日にち、料金・価格などの数字が間違っている
  • 誤字脱字が目立つ、日本語が分かりにくい

ひとつずつ見ていきましょう。

法律・モラル・ライセンス・規約などに反する内容がある

サービスとしてもスタッフとしても法律やモラルに注意しなければならないことは、わざわざ言われなくても全員が理解していることでしょう。しかし、うっかりそれと気づかずに反してしまう可能性もあり得ます。

例えば、日本で発売されていない話題の最新スマートフォンを海外で手に入れたときに、IT系の情報を発信するサイトやブログを運営していれば「最速レビュー!」とレポートしたくなるでしょう。しかし、スマホを日本国内で使用するには、技適マーク*1がついているかを確認しないといけません。

このようにガジェットの種類によって個別の法律や規制が存在していることもあり、ソフトウェアのライセンスなどを意識しているだけでは盲点になりそうな落とし穴も少なくありません。他には、ドローンの飛ばし方にも注意が必要です*2

他のWebサービスと連携したり、ボットでデータをクロールするような場合にも、各サービスで禁止されているような振る舞いをする実装になっていないか、利用規約などを確認しておきましょう。

ガジェットやツールだけでなく、情報の取り扱いにも気をつけなければなりません。個人情報の取り扱いには法律が存在しますし、重要な情報がうっかり外部から見えてしまうと、企業の損害につながりかねません。それがシステムに関する情報であれば、サイバー攻撃を呼び寄せることにもつながります。

▽関連 【保存版】エンジニアが知っておきたい法知識。ソースコード著作権&開発契約を元エンジニア弁護士に聞く!

日にち、料金・価格などの数字が間違っている

これは明らかに問題のある内容です。数字を扱う際には、普段より特に注意しなければなりません。

例えば、イベントの案内をサイトに掲載するときに、開催日がページによって異なっていたり、料金表記が間違っていたりすると参加者が戸惑うだけでなく、金銭的な損失を与えてしまう可能性もあります。

ECサイトで価格の桁を間違えて格安で販売される商品がたまにインターネット上で話題になりますが、受注をキャンセルできない場合には会社にとって大きな損失になってしまうでしょう。

誤字脱字が目立つ、日本語が分かりにくい

内容は間違ってはいないけど、文章が整っておらず、漢字の間違いも多くて読みにくい。このような状態があまり重要視されず、放置されていることはありませんか?

私自身は、非常に重要な問題だと考えています。エンジニアでも、Webサイト上の文言や、勉強会の資料など、文字を扱うことはあるはずです。悪文を見たユーザーにはメリットがないだけでなく、むしろ不信感を募らせてしまうなどのデメリットの方が大きいでしょう。

分かりにくい文章を改善するいくつかのポイント

ミスの多くは、気をつければ回避できるはずです。文字を扱うときに「ここに気をつけよう」というポイントをお伝えします。

間違えやすい項目としてインプットしておいていただき、自身の文章を確認する際に、1つでも修正のヒントになればと思います。

ポイント1:人名・企業名・サービス名には注意

固有名詞は要注意。人名・企業名・サービス名はアイデンティティそのものであり、それを間違えることは失礼なことだと考えられます。

対面で話をするときに、特に面識があまりない相手であれば、名前を覚えて間違えないように意識するでしょう。文字であってもそれは同じだと言えます。対面と同様な気遣いをすれば良いのです。

しかし、サービス名はアルファベットの大文字小文字、スペースの入れ方など、各社が独自のルールで命名しています。そのため、正式な表記を覚える、もしくは調べる必要があります。

例えば、次の企業名・サービス名表示はすべてNGです。

Youtube
Github
Yahoo!Japan

正しくは、YouTubeGitHubYahoo! JAPANです。

「いつもと何か違う」と違和感があったら、調べる癖をつけてください。迷ったら、本家サイトでどのように表記しているのかを確認しましょう。

その際は、ロゴやバナーにある「画像になっているもの」ではなくテキストとして記載されている文言を確認しましょう。正式名称は大文字でも、ロゴでは小文字表記されているパターンも存在します。また、スペースの有無はテキストを見ないと正確に判断しづらいものです。

次のブログでも、同様の固有名詞の間違い例が紹介されています。

どうしてもやってしまいがちな「固有名詞間違いあるある」 - はてな編集部ブログ

ポイント2:数字が出てきたら整合性を確認

数字は間違いが潜みやすい部分であり、間違いを見つけやすい部分でもあります。数字が出てきたら他の部分の記述と整合性があるかどうかを確認する習慣をつければ、間違いを回避できるようになるでしょう。

数字の半角・全角の表記揺れ(ポイント4を参照)も発生しやすいので、全体で統一するようにしましょう。

ポイント3:カタカナと英語(表記揺れ)

カタカナと英語は表記揺れ(ある同じ1つのものを示す語句が、同じ文章中で異なる複数の文字表示で記載されること)が発生しやすい要注意ポイントです。同じものでも、漢字・カタカナ・英語と表記の仕方がバラバラだと、それらが同一のものと理解しづらい原因になります。用語は統一させましょう。

カタカナでは「ユーザー」「コンピュータ」などからも分かるように、末尾の長音「ー」(音引き)の有無が統一されていない場合がよくあります。伸ばすのか伸ばさないのか、規則を決めて統一しましょう。

英語では、用語を示す際に単語の先頭を大文字にするかどうかが揺らぎやすいので、こちらも規則を決めて統一させましょう。

ポイント4:記号は全角文字か半角文字か

記号の表記揺れで特に多いのは、括弧の揺らぎです。(ほげ) のように、全角で始まって半角で終わるような場合も見受けられます。

また、技術ブログなどにソースコードを記述する場合に、ダブルクォートやスペースが知らないうちに全角になっていることもあります。読者がソースコードをコピペして動かそうとしたときに、半角であるべき記号が全角になっているとエラーが発生してしまい、サンプルコードを動かすためだけに1文字ずつ確認しないといけなくなってしまいます。

間違いを前提としたライティング

ここまでに紹介したような間違いは必ず存在するという心づもりで、文章を推敲しましょう。誤字脱字などは2度や3度の確認では直しきれないことが多いです。

ましてや最初から完璧な文を書くことは不可能と言っても過言ではないでしょう(もちろん、長さなどにもよりますが)。どこかに潜んでいる間違いを探し出してやろう、くらいの気持ちでいるのがちょうどいいでしょう。

どのようにミスを発見するのか? 実際の記事で確認しよう

実際には、どのような思考回路があれば誤字脱字や表記揺れを見つけられるのでしょう。私が普段気をつけていることの一部を、以前にエンジニアHubで執筆した次の記事をもとにご紹介します。

記事の先頭から順に見ていきましょう。まずは、記事のタイトルです。

今日からはじめるGitHub 〜 初心者がGitをインストールして、プルリクできるようになるまでを解説

本文に入る前に確認しておきたい単語は、タイトルの「はじめる」「GitHub」「できる」「プルリク」の4語です。

「はじめる」という単語は、文中で「はじめる」と「始める」が使われている可能性があるため、「はじめ」「始め」で本文を文字検索します。「る」を含めないのは、「はじめましょう」のような使い方をしている可能性があるためです。

「GitHub」は、文中で「Github」とNG表記になっていないかを確認しておきます。

「できる」という単語も「でき」「出来」で揺れていないかを検索します。

「プルリク」はカタカナ表記なのか英語表記なのか(英語表記でも「Pull Request」「PullReq」など表記の仕方は様々な可能性がある)、そもそも統一されているかを確認します。

タイトルだけでも、確認すべきものがこれだけ潜んでいました。

エンジニアであれば、チーム開発ではもちろんのこと、個人開発でもGitを用いてバージョン管理していきたいもの。今回は、GitやGitHubをはじめて使う人に向けて、導入から初歩的な使い方までを解説します。

「GitHub」「はじめて」はタイトルで確認しているのでここではスルーします。

ソースコードの管理はできていますか? ファイルを修正するときに、修正前のソースコードをhoge.php.bakのようなバックアップファイルとして残し、開発環境をゴミだらけにしていませんか?

「とき」が「時」と、「ような」が「様な」と揺れていないかそれぞれ確認します。「できて」は、タイトルで出てきた「でき」で確認済みです。「できる」と検索しなかったため、このような場合の漏れがありません。

エンジニアであれば、チーム開発ではもちろんのこと、個人開発でもGitを用いてバージョン管理していきたいもの。今回は、GitやGitHubをはじめて使う人に向けて、導入から初歩的な使い方までを解説します。

「GitHub」と「はじめて」は確認済みなので、ここでは「こと」が「事」と揺れていないかを確認します。

ここではGitの詳細な仕組みには触れません。GitやGitHubを利用したことのない人が、Gitを用いた開発の流れをざっくりと理解し、とりあえず試すことができるようになることを目的としています。

「GitHub」「こと」「できる」「ような」は既に確認済みなので、ここも問題なしです。

このように、気になるものが出現したら、その都度検索をかけて本文を確認しています。上記の冒頭部分の確認の流れでも分かるように、確認が進めば進むほど、注意すべき単語が減っていくため、確認のペースは上がっていくでしょう。

一度中断すると、どの単語が確認済みだったのか忘れてしまいがちなので、このペースアップの流れで一気に確認してしまうのが得策だと思います。

まとめ

いくら素晴らしいUIやシステムであっても、添えられている文字がおかしければ、その価値を下げてしまうでしょう。文字もある意味でデザインであり、誤字脱字などはデザインを崩す行為だとも言えます。

今回紹介した要注意ポイントを意識して、怪しい単語を見つけたら全体の文を見直してみてください。きっと役に立つときがくるでしょう。

また、プロダクトと直接関係がない場所でも、社員がSNS上で問題発言をしたり、所属名やそれが推測できるアカウントで好ましくない発信をしていると、所属先の印象にも影響する可能性があります。社員全員がそのようなリスクを意識するよう社内教育も必要になってきます。

個人の発言が企業の見解だと捉えられるリスクもあるので、何か意見する場合には「所属する組織の見解ではない」と一言添えておくのもリスクを軽減させる策の1つでしょう。

執筆者プロフィール

池田健人(いけだ・けんと) @ikenyal

id:ikenyal
サーバサイドエンジニア。学生時代に研究室や学部の各種サーバ・ネットワーク構築などを経験し、プログラミング以外の技術も学ぶ。2011年に某Web系IT企業に入社。エンジニア職でありつつも、校正スキルには自信あり。現在はリーダーとしてマネジメントスキルを習得中。

*1:「技適マーク」は、電波法令で定めている技術基準に適合している無線機であることを証明するマーク。技適マークがついていない(電波法に基づく「技術基準適合証明」を受けていない)無線機器を使用すると、電波法に抵触し法令違反となる。
参照:総務省 電波利用ホームページ | 技適マーク、無線機の購入・使用に関すること

*2:ドローンと航空法…ドローンは「無人航空機」にあたるため、空港などの周辺の上空の空域・150m以上の高さの空域・人口集中地区の上空を飛行する場合に国土交通大臣の許可を受ける必要がある。その他、夜間飛行など特定の条件下では地方航空局長の承認を受ける必要がある(2017年10月17日現在)。
参照:航空:無人航空機(ドローン・ラジコン機等)の飛行ルール - 国土交通省