×
Namespaces

Variants
Actions

記事の表現形式について

From Nokia Developer Wiki
Jump to: navigation, search
Article Metadata
Article
Translated:
By fnjwikimng
Last edited: hamishwillee (09 Dec 2011)


注意事項:
下記ドキュメントは原文の日本語訳ですが、日本語と英語における基本的な表記法の違いにより、原文にある一部項目を修正・削除しています。ドキュメントの性質上、日本語記事でも一部の表記が英文になる場合は想定してますが、全面的に英文になる場合は想定していません。その場合は原文をご覧ください。


Contents

頭字語・略語について

記事の読み手が、書き手が使用する頭字語や略語を知っているものと仮定してはいけません。頭字語や略語は、最初に出てきた時は略さずに書き、その直後に括弧付きでそれらを示すようにします。(例: integrated development environment(IDE)) また、i.e. e.g. といった略語の使用は避けるようにします。


頭字語は、複数の意味を持つことがあります。

たとえばIDEだと、Integrated Development Environment, Integrated Drive Electronics, Interactive Design and Engineering, Interface Design Enhancement の頭字語はすべてIDEです。Integrated Development Environmentだけが、IDEを構成する語ではありません。

見出しにおける大文字の使用について

見出し(heading)が英文の場合、最初の文字と固有名称のみ大文字にします。

キャプションについて

全ての図、表、写真には、キャプションをつけるようにします。また、長めのコード例にもキャプションをつけるようにします。その場合、ラベルとして「例」を使うようにします。 キャプションの長さは、1パラグラフ以上の長いものにしないようにします(1行にするのが望ましいです)。 キャプションが英文の場合、最初の文字を大文字にするのは、最初の単語、固有名称、コードのみにします。キャプションが完全な1つの文になっている場合、句読点で終わるようにします。そうでない場合、句読点を最後につけないようにします。

端末の名称について

型番の前に必ず"Nokia"をつけるようにします。Nokia NシリーズやNokia Eシリーズの端末でも同様です。 また、S60端末は通常スマートフォン(smartphone)と呼ばれます。

表記例:

  • Nokia E61
  • Nokia N70
  • Nokia 5500 Sport
  • Nokia 3300 music phone
  • Nokia N-Gage™ mobile game deck, Nokia N-Gage™ QD mobile game deck
  • Nokia 9300 Communicator, Nokia 9500 Communicator

ファイル名とその拡張子について

ファイル名とその拡張子は、コード用フォントを使用するようにします。

"Java"の表現について

"Java"が最初に出てきた時には、商標記号 ( ™ ) をつけるようにします。 全ての商標と同様に、"Java"は単独で、すなわち、1つの名詞もしくはハイフンつきで他の語をくっつけたものとして使用することはできません(よって"Java-enabled"は認められません)。常に修正されるもので、Java application, Java platform, Java technologyといった、一般的な参照も含みます。 表記として、"Java 2 Platform, Micro Edition (J2ME)"は使わないようにし、"Java Platfrom, Micro Edition (Java ME)"を使うようにします。

リストについて

リスト中で、英文表記の全項目について、最初の語を大文字にします(ただしelkwareなど、小文字表記の固有名詞は別です)。各項目は句読点で終わるようにします。 順序なしリストでは黒丸リスト(・)を使用し、ステップシーケンスなど、順序つきリストでは番号リストを使用します。

人称・態(能動態/受動態)について

不特定多数の人をターゲットにする場合、三人称を使用します。(例.プログラマ・マーケッター用の導入マニュアル) 特定の人をターゲットにした(すなわち、曖昧性がない)、特に説明書などといったコンテンツでのみ、二人称を使用します。 多くの文章では能動態を使用します。明確かつ直接的で、さらに受動態よりも少ない語数で済むからです。例外としては、科学、医療、あるいは形式的な文章があり、それらの場合は受動態を使用する方がより適切です。

プラットフォーム(platform)の表記について

上付き文字は使わないようにします。例: "S60 3rd Edition" ("S60 3rd Edition"は不可)
また本文中では、Series 40 platform, S60 platform, Series 80 platformについて、"platform"を大文字表記にしないようにします。

Series 40 platformの表記例:

  • the Series 40 platform
  • Series 40 2nd Edition
  • Series 40 3rd Edition, Feature Pack 1

S60 platformの表記例:

  • the S60 platform
  • S60 2nd Edition
  • S60 3rd Edition
  • S60 2nd Edition, Feature Pack 1
  • the Nokia Web Browser for S60
  • the S60 emulator
  • S60 smartphone
  • S60 licensee

リファレンス・リンクについて

参照文献がある場合、下記形式を使用します:
タイトル、著者名、出版社、ISBN

ドキュメントあるいは例のリファレンスの場合、その名前を正確に略さず書きます。ただし、バージョン番号は使わないようにします。

リンクする時は、それが正しく機能していることを十分確認してください。Nokia Developer のリソースにリンクする場合、リソースのinfoページへのリンクを指すようにします(URLは http://www.developer.nokia.com/ で始まります)。

SDKの名称について

SDKの名称として使われる場合、"Edition"の"E"は大文字を使用します。

"Symbian"について

"v"の文字と共に、バージョン番号をつけて使用します。例.Symbian OS v7.0s

トピックの管理について

小見出し(sub-heading)は、読者が記事の概要を理解し、興味のあるサブトピック(subtopic)を見つけるのに便利です。セクションが非常に長くなり、適切な小見出しを選択することがその説明の手助けになる場合、小見出しを作成するようにします。 可能な限り、セクションの見出し・小見出しは変更しないようにします。他の記事がそのセクションにリンクしている可能性があるからです。その場合、そのセクションへのリンク切れを起こすことになります。リンクなしでセクションを参照する場合、セクション名をイタリック表記にします。セクションがリンク付きの場合、セクション名をイタリック表記にしてはいけません。

トピックの表題について

  • 見出しに、アンパサンド(&)、プラス記号(+)、波括弧({})、角括弧([]) といった特殊文字の使用は避けるようにします。ただし、正式名称の一部の場合はこの限りではありません。
  • 見出しにはリンクを置かないようにします。その代わりに、セクションの文中で最初に出てきたその語をリンクするようにします。
  • 見出しは短くするようにします。長すぎる見出しは、その目的を打ち砕いてしまう可能性があります。
  • 見出しに代名詞、記事表題の繰返しといった、冗長または不要な語を使わないようにします。
  • 異なるセクションに同じタイトルをつけないようにします。もしそうしてしまうと、読み手を混乱させることになり、また、書き手が最初でない途中のセクションへのリンクを作成することが困難になります。

オンラインライティングのガイドライン

  • トピックは短くするようにします。
  • Webオーサリングスタイルで、最低限のことだけを記述するようにします。「しかしながら(however)」「それゆえに(therefore)」「本トピックでは(In this topic)」などといった、実情報と違う余計な語の使用は避けるようにします。
  • 各トピックのコンテンツは、ざっと見られる、要約できる量に分解するようにします。コンテンツは、見出しをつけたブロックに分解するようにします。1つのパラグラフには1つの事柄のみ書くようにします。書くパラグラフは短く(最大でも6行)します。
  • 主題は最初に提示するようにします。重要情報をトピックの最後に置かないようにします。ユーザーがそこまでスクロールダウンするとは限らないからです。
  • リンクについては十分考慮し、リンクが正しく機能するか確認するようにします。
  • 記述に一貫性を持たせるようにします。

フォーマットに関する問題について

フォントサイズ、空白スペース、色といったフォーマットの問題は、Wikipediaサイト全体のスタイルシートに関わる問題であり、特別な場合を除き、記事中でそれは使わないようにします。フォントサイズを指定する必要がある場合、"font-size: 80%;"などといった相対サイズを使用するようにし、"font-size: 8pt;"などといった絶対サイズは使用しないようにします。また、フォントの種類、色、その他のスタイルを変更するのも、あまり良い方法とはいえません。

一般的に、カスタムフォントの使用は

  • 整合性を損ないます。そのテキストには、一般的なテキストの持つ一貫性はありません。
  • ユーザビリティを損ないます。上書きするためにユーザーがカスタムスタイルシートを適用することは(たとえば、アクセシビリティ上の問題から)難しくなります。また、各スキン間の不調和を起こす可能性があり、色覚異常の人を悩ませることにもなり得ます。
  • 意見の衝突が起こりやすくなります。美的価値観の点から、そのフォントスタイルの選択に同意しないWiki記事の作者(Wikipedian)と議論を始める可能性も秘めています。

そのような理由から、一般的に、記事中のフォント属性のためにインラインCSSを適用するのは良い習慣とされていません。

マークアップについて

実用的で理解しやすい方法で情報を表示するため、マークアップは極力簡単なものを使用するようにします。マークアップはブラウザによって表示が異なります。HTML,CSSのマークアップは控えめにし、相応な理由がある時のみ使うようにします。記事中のマークアップを最小限にすることで、編集が容易になります。特に、CSSでfloatまたはline-heightプロパティは使用しないようにします。ブラウザによっては、大きなサイズのフォントを使用した時にレンダリングを崩してしまう原因となるからです。

This page was last modified on 9 December 2011, at 05:52.
87 page views in the last 30 days.
×