再利用できる文書の書き方

IDIA.JP > レポート > 再利用できる文書の書き方
再利用できる文書の書き方

「伝わりやすさ」と「視覚的な見やすさ」、さらに「再利用性」を考慮した文書を書く際に気をつけるべきポイントについてまとめた。随時編集予定。

再利用性のある文書の必要性

2014年に勧告が予定されているHTML5では、よりセマンティックなHTMLのマークアップが可能となっている。それに伴い、HTML4やXHTMLで書かれた文書の再マークアップが期待されている。しかし、Web上に公開されている多くのHTML文書では、文書の構造や表記の方法に問題があり、システマチックに再マークアップすることが難しい。

一方、Webで公開される文書はいわゆる「ホームページ」の形だけではなく、RSSやSNS、ニュースサイトを通じて複数の方法で配信され、同時にスマホやTVなど多様な環境で表示される。またそれらの文書は何らかの形で保存され、永続的に再利用されたり参照されたりする可能性がある。再利用される可能性を考慮して文書を作成することは、文書の伝播力や価値を高めるのに役立つと考えられる。

新しく文書を書く際はもちろんのこと、これまで書かれた文書を再マークアップする際にも気をつけたいポイントを以下に挙げた。

構造

構造と見出し

文書に階層構造を設ける
文章を内容ごとにまとめ、階層構造を設ける。
適切に小見出しをつける
階層ごとに適切な小見出しをつけることで、文書の構造や内容を理解する補助となる。

テキストの書き方

全角、半角

英数字は原則半角で表記する
英数字を半角で表記することはコンピューターでテキストを書く上の基本ではあるが、慣習などにより遵守できていない場合も多い。
例)1,250円→1,250円
半角カナを使用しない
携帯電話などで用いられることの多い半角カナは、他のデバイスで閲覧する可能性のある文書では使用しない。
例)ハンカクカナ→ハンカクカナ
記号は全角で表記する
日本語文章中では「?」「!」「&」「<」などの記号を全角で表記する。いずれも半角にすると、コンピューター上でプログラム的に意味のある記号として認識されることがある。英語文章中の場合はHTML特殊文字を用いる。
例)発売中!→発売中!
全角スペースを使用しない
これは絶対ではないが、全角スペースは半角スペースで代用したほうが良いケースが多い。
例)山田 太郎→山田 太郎
名前の区切りのルールを統一する
苗字や名前が一文字の名前のことも考慮しながら、区切りのルールを統一する。
例)山田 太郎、鈴木花、佐藤 一郎→山田 太郎、鈴木 花、佐藤 一郎

括弧

二重かぎ括弧はかぎ括弧の中で使用する
目立たせるために二重かぎ括弧を単独で用いるのは避ける。
例)「この『魔法の本』を持ち出せばいい」
丸括弧は全角で書く
日本語文章中で半角括弧を使用すると、前後に半角スペースで余白を設けているのをよく目にする。全角括弧を使用すると、余白が適切に施された読みやすい文章になる。
例)CD(コンパクトディスク)→CD(コンパクトディスク)
使用する括弧の種類は少なめに
ひとつの文章中に沢山の種類の括弧を用いると、括弧の使用方法のルールにばらつきが生じ、強調の効果もぼやける。使用する括弧の種類は3つ程度に止め、効果的に用いる。
例)「」『』()【】[]《》{}→「」()
参考:括弧の使用例
種類呼び方用途
「」かぎ括弧会話、引用、固有名詞、慣用句、強調
『』二重かぎ括弧書名、「」内で用いる「」
()丸括弧補足、注記、読みがな、外国語、省略
[]大括弧見出し、引用、参照、強調
【】隅付き括弧見出し、注記、強調
〈〉山括弧強調
“”ダブルクォーテーション外国の書名、外国語、強調
‘’シングルクォーテーション強調

日時

日時には西暦を書き添える
Web上に公開した文書は将来的にも読まれる可能性がある。日時には和暦、もしくは西暦を書き添える。和暦は生年月日以外では西暦に置き換えたほうが便利なことが多い。
例)2月4日開催!→2010年2月4日開催!
西暦は4桁で書く
西暦は2桁で表記することもできるが、できる限り4桁で表記する。
例)02年に開催されたワールドカップ→2002年に開催されたワールドカップ
曜日を書き添える
曜日を書き添えることで、西暦がなくとも日時を特定するヒントになる。
例)11月2日→11月2日(金)
年月日の書式を揃える
Webサイト単位で、少なくともページ単位では年月日の書式を揃える。
例)2012/01/11、2012年1月11日、2012.01.11→2012年1月11日

外国語の表記

大文字、小文字のルールを決める
特に固有名詞では大文字、小文字を指定しているものがあるので注意する。
例)word、EXCEL、iphone→Word、Excel、iPhone
カタカナ表記ができるものはカタカナで表記する
それほど馴染みのない言葉を無理にカタカナ表記をすると「表記のゆらぎ」という別の問題が起こる可能性があるが、一般的に使用されているカタカナ表記がある場合はそれを用いる。
例)Apple→アップル
スペースの有無を統一
固有名詞では、単語間にスペースを設けていないものも多い。
例)Word Press→WordPress
中黒の有無を統一
中黒は単語の区切りに用いられることが多い。
例)ジョンレノン→ジョン・レノン
語尾の長音のルールを統一する
語尾の長音の有無は業界や時代ごとに変遷している。
例)コンピュータ、コンピューター→コンピューター

記号

中黒は区切りに使わない
同格の情報の並列に中黒を用いない。
例)ジョン・レノン・リンゴ・スターなど→ジョン・レノン、リンゴ・スターなど
三点リーダーを使用する
「余韻」や「沈黙」を表すのに中黒を使用しない。
例)嘘じゃなかった・・・→嘘じゃなかった……
絵文字、アスキーアートを使用しない
意図する表示ができない環境が多い絵文字やアスキーアートは、広く読まれる可能性のある文書ではできる限り使用しない。

ユーザビリティ

SEO、ユーザビリティ

機種依存文字を使用しない
用いる記号が機種依存文字かどうか疑う習慣をつける。
例)㈱、〠→(株)、〒
「こちら」のテキストリンクを使用しない
リンクを示すテキストはリンク先のページのタイトルか、概要を表すものにする。
例)こちらを参照→イディア:情報デザインと情報アーキテクチャを参照
テキストの全角スペース、タブなどで見た目を調整しない
スペースを用いると意味の連続が途切れてしまう。見た目はCSSなど他の方法で調整する。
例)凡 例→凡例

まとめ

再利用できる文書の書き方のポイントは以下のとおり。

  • 文書の構造を意識する
  • 単語や文章の「意味の区切り」を保持する
  • テキストで見た目を調整しない
  • 他人(未来の自分を含む)が読んでもわかりやすいように書く

参考

記事のデータ

文責IDIA.JP
公開日2012年11月2日
カテゴリー
タグ
関連する記事

記事を共有する