Lindelin

日本語ドキュメント作成スタイル基準規約

本規約の目的は、記事または、ドキュメントにおいて統一されたスタイル標準に従って、読みやすく綺麗な文章を作ることです。

前提条件

あいまいさを避けるため、あらかじめ下記日本語の表現についてのご理解いただけますようお願い申し上げます

  • 〜しなければなりません:必須。
  • 〜してはいけません:厳禁、禁止。
  • 〜したほうがいいです:するべきです。オススメです。
  • 〜しないほうがいいです:不向き、不適切なやり方。
  • 〜してもいいです:可能、許可。
  • 日本語:ここでの意味は、平仮名・片仮名・漢字のことを指します。
  • 英文字:ここでの意味は、アルファベットのことを指します。
  • 文章記号:ここでの意味は、句読点やかっこなどすべての文章記号を指します。

概要

スペース

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

正確:

Lindalë は Laravel 5.3 の上に構築されているため、いくつかのシステム要件があります。

このパッケージを使用すると、Amazon ELB を使用している際、Laravel プロジェクトがセキュア接続(HTTPS)を正しく認識することができます。

不正確:

LindalëはLaravel 5.3の上に構築されているため、いくつかのシステム要件があります。

LindalëはLaravel5.3 の上に構築されているため、いくつかのシステム要件があります。

このパッケージを使用すると、AmazonELBを使用している際、Laravelプロジェクトがセキュア接続(HTTPS)を正しく認識することができます。

例外:

GMOインターネットグループは、1995 年以来インターネットに関するさまざまな商材やサービスをお届けしています。

「GMOインターネットグループ」など、会社名などの固有名詞はそのまま使用しなければなりません。

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

正確:

100 円ショップ(ひゃくえんショップ)とは、店内の商品を原則として 1 点 100 日本円均一で販売する形態の小売店。 別名「 100 円均一」、およびそれを省略した「100 均」(ひゃっきん)と呼ばれることもある。

不正確:

100円ショップ(ひゃくえんショップ)とは、店内の商品を原則として1点100日本円均一で販売する形態の小売店。 別名「100円均一」、およびそれを省略した「100均」(ひゃっきん)と呼ばれることもある。

100 円ショップ(ひゃくえんショップ)とは、店内の商品を原則として1点 100日本円均一で販売する形態の小売店。 別名「100円均一」、およびそれを省略した「100均」(ひゃっきん)と呼ばれることもある。

例外:

「3つ、6個、9件」などの数詞と「2017年6月4日」などの年月日は日本語との間に半角スペースを入れなくてもいいです。 ただし、数詞及び年月日は全体として、日本語との間に半角スペースを入れなければなりません。

正確:

エクスペディアは横浜の 3つ 星ホテルも全て最低価格保証。

エクスペディアは横浜の 3 つ 星ホテルも全て最低価格保証。

その国際会議は今年の 2017年6月4日 に開催されるはずだった

その国際会議は今年の 2017 年 6 月 4 日 に開催されるはずだった

不正確:

エクスペディアは横浜の 3 つ星ホテルも全て最低価格保証。

その国際会議は今年の2017年6月4日に開催されるはずだった

その国際会議は今年の2017 年 6 月 4 日に開催されるはずだった

単位と数字の間に半角スペースを入れなければなりません

正確:

この週末は、SSD やハードディスクなどストレージの特価品が目立った。 特に注目したいのが、クルーシャルの 512 GB 版 SSD「M550 CT512M550SSD1」だ。

IEEE 802.11a および IEEE 802.11g を高速化した規格。2.4 GHz 帯および 5 GHz 帯を使用し、最大リンク速度 600 Mbps

不正確:

この週末は、SSD やハードディスクなどストレージの特価品が目立った。 特に注目したいのが、クルーシャルの 512GB 版 SSD「M550 CT512M550SSD1」だ。

IEEE 802.11a および IEEE 802.11g を高速化した規格。2.4GHz 帯および 5GHz 帯を使用し、最大リンク速度 600Mbps

例外:度(°)・百分率(%)と数字の間に半角スペースを入れてはいけません

正確:

スタジオセット 360° ビューでは、ドラマの撮影現場を 360° 画像で紹介します。

sRGB より 25% 多い色

不正確:

スタジオセット 360 ° ビューでは、ドラマの撮影現場を 360 ° 画像で紹介します。

sRGB より 25 % 多い色

全角文章記号と文字の間にスペースを入れてはいけません

正確:

Thunderbolt 3 は、超高速の帯域幅と USB-C 業界標準による極めて高い汎用性の両方を、1つ の強力なユニバーサルポートにまとめました。

又吉直樹が小説「火花」の収入を指摘され動揺「4 億円くらい入りますよね?」

不正確:

Thunderbolt 3 は 、 超高速の帯域幅と USB-C 業界標準による極めて高い汎用性の両方を 、 1つ の強力なユニバーサルポートにまとめました 。

又吉直樹が小説 「 火花 」 の収入を指摘され動揺 「 4 億円くらい入りますよね ? 」

文章記号

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

正確:

卓球女子、平野美宇が日本初優勝!

不正確:

卓球女子、平野美宇が日本初優勝!!!!!!!!!!

卓球女子、平野美宇が日本初優勝!!!!

卓球女子、平野美宇が日本初優勝!!

Nintendo Switch まさかの爆売れ!!!!!売れた理由を分析してみた。。。

全角と半角

全角と半角が分からない方、→『全角と半角』。

全角文章記号を使用しなければなりません

正確:

市では、観光やイベント情報、防災情報など様々な情報を広報するため、Facebook ページの運営を開始しました。

不正確:

市では,観光やイベント情報,防災情報など様々な情報を広報するため,Facebook ページの運営を開始しました.

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

正確:

Switch は発売前に 200 万台の出荷を計画していたらしいけど、現在の実績として 274 万台を出荷しているそうです。

不正確:

Switch は発売前に 200 万台の出荷を計画していたらしいけど、現在の実績として 274 万台を出荷しているそうです。

例外:デザイン上で、全角数字を使用しなければならない場合は、全角数字を使用してもいいです。 また、住所や番地など全角数字を使用してもいいです。

英語文章は半角文章記号を使用しなければなりません

正確:

スティーブ・ジョブズがスタンフォード大学で語ったスピーチ。 最後に「Stay hungry, stay foolish」で締めくくられていることはあまりにも有名ですが、この言葉の真意はどこにあるのでしょう?

不正確:

スティーブ・ジョブズがスタンフォード大学で語ったスピーチ。 最後に「Stay hungry、stay foolish」で締めくくられていることはあまりにも有名ですが、この言葉の真意はどこにあるのでしょう?

固有名詞

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

正確:

今まで使ったことがない初心者向けに「GitHub の使い方」を解説した記事です。

GitHub、Foursquare、Microsoft Corporation、Google、Facebook、Skype、PHP、Java、Ruby、IoC、PlayStation 4

不正確:

今まで使ったことがない初心者向けに「github の使い方」を解説した記事です。

今まで使ったことがない初心者向けに「Github の使い方」を解説した記事です。

今まで使ったことがない初心者向けに「gitHub の使い方」を解説した記事です。

github、foursquare、microsoft corporation、google、facebook、skype、php、java、ruby、ioc、playstation4

GITHUB、FOURSQUARE、MICROSOFT CORPORATION、GOOGLE、FACEBOOK、SKYPE、Php、JAVA、RUBY、IOC、PLAY STATION 4

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

正確:

jQuery とは、JavaScript を寄り容易に記述するために設計された JavaScript ライブラリのことです。

jQuery UI はインタラクティブな Web サイトを開発するために使用される、jQuery をベースにした JavaScript のライブラリである。

不正確:

jQuery とは、Js を寄り容易に記述するために設計された js ライブラリのことです。

JUI はインタラクティブな Web サイトを開発するために使用される、jQuery をベースにした js のライブラリである。

その他

リンクと文字の間に半角スペースを入れたほうがいいです

強制しないですが、半角スペースを入れたほうがいいです。 ただし、入れるや否や、ドキュメント内において一貫性を持たせなければなりません。

正確:

読みやすく綺麗な文章を作るには日本語ドキュメント作成スタイル基準規約を守らないといけない。

読みやすく綺麗な文章を作るには 日本語ドキュメント作成スタイル基準規約 を守らないといけない。

不正確:

読みやすく綺麗な文章を作るには日本語ドキュメント作成スタイル基準規約 を守らないといけない。

PSRはPHP-FIG(PHP-Framework Interoperability Group)が取り決められた PHP コーディング規約 です。

参考

基準通りで作られているサイト


TOP