@IT/Insider.NET執筆ガイド

@IT/Insider.NET向けに執筆するに当たり参考にしてください。

文体と表現(Styles&Structures&Expression)

 

●「だ・である調」採用と、その理由

基本的にInsider.NETでは「だ・である調」で統一しています。
「です・ます調」の方が丁寧な印象があり一般的ですが、Insider.NETのコンテンツは(基本的に)技術文書なので、簡潔さを重要視して「だ・である調」を選択しています。
ですので、特別な理由がなければ、「だ・である調」での執筆をお願いしています。

 

●厳密さの重視1:暗黙の省略をできるだけ無くす

日本語でも英語でも、知識レベルが同じ場合は暗黙の了解で、単語に続く定義などが省略される場合が多い。しかし技術文章の場合は、あいまいさを無くし、その意味を明確にして、読者に無用な間違えや勘違いを極力無くすため、基本的に省略を一切しない。

例(省略の例):「C:\Users」を開き

例(厳密な説明の例):Windowsエクスプローラで「C:\Users」フォルダを開き

例(省略の例):C#からHTMLを読み込み

例(厳密な説明の例):C#コードから、sample.htmlファイルのHTMLデータをテキストとして読み込み

 

●厳密さの重視2:誰も読み間違えない文章を目指す

「常識で考えれば分かるだろう」という認識は捨て、「勘違いや誤解を与える隙を作らないようにする」という認識で文章を磨き上げる。読者に行間を埋めてもらうような文章や、読者の知識や直感に頼る文章は徹底的に避ける。

 

 

●厳密さの重視3:文章と値の境界を明確に分ける

例:a~zの値を入力する

この場合、何かを勘違いして読まれた場合、
「a~zの値」を入力する
「a~z」の値を入力する
「a」~「z」の値を入力する
の3種類の意味で受け取られる可能性がある。

こういうあいまいさの問題を回避するため、以下のように記述する。

「a」~「z」の値を入力する

 

●厳密さの重視4:文章とコードの境界を明確に分ける

コードを文章中で示す場合も境界を明確にする。
例(×):bind('pageinit')を記述する

例(○):「bind('pageinit')」を記述する

逆に、コードではなく、名称の場合は文章なので境界を作らない。
例(×):「bind」を呼び出す

例(○):bind関数を呼び出す。

 

例:id属性 = この場合はコードではなく名称として記述している。
例「id」   = この場合は名称ではなくコードとして記述している。

 

■Xxxx+Insider.NET 独自の技術関係の表現ルール

●「ユーザー」という表記について

ユーザーといっても、アプリ開発者のことを指す場合もあれば、最終的なアプリの利用者を表す場合もある。例えば「この機能を使うユーザー」という表記では、開発者がプログラミング上でその機能を使うのか、エンド・ユーザーが一般利用上でその機能を使うのか明確に判別できないことがある。
そういう問題を回避するため、開発者の場合は「ユーザー」という表記でよいが、アプリ利用者は基本的に「エンド・ユーザー」と表記する。
ただし、利用者しか登場せず、間違えようがない場合は、「ユーザー」でよい。
また、開発者と利用者が登場するが、記事全体に渡って利用者以外に「ユーザー」にならない場合は、「本稿での「ユーザー」という表記は、アプリの利用者を意味する「エンド・ユーザー」のことを指す」などの前置きを加えたうえで、「ユーザー」に統一する。


名前空間の書き方

例:Fileクラス(System.IO名前空間)

 

●HTMLやXAMLなどのタグや要素の書き方

例:<app>要素
例:<app>タグ
例:appクラス


戻る → 日本語文章の執筆規約

 

参考文献: