ブログ記事にも規約を策定することで「読みやすさ」を改善きる、というお話です。

今回は「どのような記事を書くか」という記事そのものの内容ではなく「表記・表現のルール」という範囲に限定いたします。

なぜ?

プログラムは書くことよりも、読むことを意識するべし 」ということは多くの方がお話しているとおりで、読みやすさ、保守性を向上するために一定のルールに従ってプログラミングすることはとても大切です。


私も「規約に準拠したコーディング」をする習慣があります。

ところがそれは、あくまでも製品のプログラムなどで、Wiki やチケットに対して「そこまでする」という意識はありませんでした。
もちろんブログについてもです。

ある時「当ブログは規約を設けています」と宣言をしているブログに巡り合い、「ブログもドキュメントであって標準化することで読みやすさを改善できる」んだなあと気づきました。

(そのブログをメモしておらず、わからなくなってしまいました。)

どのように

atuweb では、Lindelin(リンデリン)さんが公開している次の規約を参考にしております。

Lindelin 日本語ドキュメント作成スタイル基準規約
http://jp.lindelin.org/blog/2017/japanese-copywriting-guidelines/

Lidelin さんはオープンソース活動や IT コンサルなどの活動をしておられる団体です。


「日本語ドキュメント作成スタイル基準規約」よりいくつか引用いたします。
詳細な規約は上記 Lindelin さんのサイトをご覧ください。

正確な固有名詞を使用しなければなりません

大文字、小文字は間違えやすいですが、正確に表記をしましょう。

Good

jQuery
GitHub

Bad

jquery
github

公認されていない略称を使用してはいけません

すべての方に略語が通じるとは限りません。
また、一般的ではない略語は読み手に恐怖を与えます。

Good

JavaScript
Facebook

Bad

Js
FB

日本語と英文字の間に半角スペースを入れなければなりません

半角スペースを入れるととても読みやすくなります。

Good

当サイトは Laravel と Vue.js で構築しています。

Bad

当サイトはLaravelとVue.jsで構築しています。

文章記号を重複の使用してはいけません

記号を重複させるのは正しい使い方とは言えませんね。

Good

やばい、これおいしすぎ!

Bad

やばい、、、これおいしすぎ!!!

半角数字を使用しなければなりません

Good

プログラマは 35 歳で定年という説があります。

Bad

プログラマは 35 歳で定年という説があります。

おわりに

私自身、なんとなくブログを書いましたが、ちょっとしたルールを決めることで全体の統一できるものだなと実感しました。

古い記事は当記事の内容に沿っていないものもありますが、ボーイスカウトルール と同じく「手を入れるときは綺麗にして帰る」ようにしています。


伝えることはとても難しいことです。

文章が独りよがりになっていないことはもちろんですが、単語や表記を統一することで ちょっとでもブレをなくし、齟齬をなくし、伝えたいことを伝える ことが大切なのだと考えています。

この記事は tomita@atuweb がお届けしました。

日本語スタイルガイド(第3版)

一般財団法人テクニカルコミュニケーター協会
出版社:テクニカルコミュニケーター協会出版事業部  発売日:2016-04-22

Amazonで詳細を見る