このページでは、Brain Wiki を編集する際の指標を説明しています。
編集する前に一度読むと、より読みやすい記事を制作することができます。
分かりやすく、読みやすい文章を書くために
日本語と英語の「分かち書き」
Brain Wiki では、日本語と英語が混在する文章を分かち書きすることを推奨しています。
ここでの「分かち書き」とは、単語と単語の間を半角スペースで区切ることを指します。以下に例を示します。
Brain Wiki は SHARP 製ハイエンド電子辞書「Brain」の Windows CE を用いてあんなことやそんなことやいろんなことをする情報を集約する Wiki です。
このように、”Wiki” と "は" や、"集約する" と "Wiki" との間の半角スペースのように、読みやすさを向上させることができます ただし、約物(句読点や記号)のとなりは、半角スペースを書く必要はありません。以下に例を示します。
このページでは、Brain で何ができるかを説明します。
上のように「このページでは、」と「Brain で」の間には、半角スペースは置きません。
文章は「です」「ます」調
Brain Wiki では、文章を敬体(「です」「ます」調)で書くことを推奨しています。
依頼は「~します」で書く
Brain Wiki で操作の手順を示すときは「~します」で書くことを推奨しています。以下に例を示します。
まず、Task Switcher をダウンロードして解凍します。
文末を「~します」にすれば「~してください」「~しましょう」と比べて冗長な表現を減らせます。ただし、全体の文章を読んで不自然な場合はこの限りではありません。
余計な修飾語や表現を除く
「いろいろ」「といった」「非常に」「とても」などといった言葉は一文を無意味に長くします。使用する場合は、それが適切かどうか確認してください。
箇条書きには句読点を入れない
箇条書きの利点は、項目ごとに読みやすくするための物です。句読点(「、」や「。」)を利用すると冗長な表現になり、箇条書きの利点が失われてしまいます。
また、箇条書きを利用する際の項目は、単語・一文であることが望ましいです。項目に対する補足説明をするために、ネストを下げる方法がありますが、ネストを下げすぎると、レスポンシブデザインに対応できなくなるため、第 2 レベルまでを目安に書きます。
画像や表にはキャプションをつける
画像が示すものについて説明をすれば、より親切です。特に、手順や機能を説明する際の、文中に参照するよう示す説明図は、「写真右」や「図 1」などのように名前や位置を説明してあげましょう。
感情を排除する
読みやすい文章にするために、「~と思います」「~だと考えます」「楽しい」「面白い」「悲しい」といった感情を書くのは基本的に控えてください。
正しい情報を伝えるために
ファイルのリンク切れに注意する
Windows CE 全盛期のファイルには、個人サイトで公開されていた物が多くあります。個人サイトの維持が行われなくなった場合、ファイルのダウンロードができなくなることもあります。これを防ぐため、Internet Archives を用いてページを保存したり、「二次配布」を許す文言またはライセンスの明記がある場合、データを他の場所にミラーすることを考えてください。
なお、「Brain 2ch 用アップローダー」は現在、管理されていません。ファイルの公開は可能ですが、推奨しません。
また、Brain Hackers が管理するリソースに「Brain Wiki ファイル公開ディレクトリ」が存在します。条件を満たせば、こちらに公開することも可能です。詳しくは、Brain Hackers にお問い合わせください。
著作権に注意する
Flash や エミュレータ・ゲームソフトなど、違法にアップロードされたファイルへのリンクへ誘導しないでください。
気持ちよく利用するために
こだわりすぎない
上記に示した指標はあくまでも指標です。特に文体については、忠実に守りすぎる必要はありません。
時と場合によって、柔軟に対応してください。
こわがりすぎない
指標を重く感じて、必要以上に公開を怖がる必要はありません。
万が一、ミスがあったとしても、管理人をはじめとするたくさんの編集者が、よりよい方向へ共同で改善していくことでしょう。
まずは、公開してみてください。
気になったことはきいてみる
気になったことは、どんどん聞いてみましょう。
現在、Brain Wiki の利用者や管理者と交流ができる場所は、次の通りです。
- Brain Hackers 公式 Discord (招待リンク : https://discord.gg/UD8qHhs)
- BrainWikiについて語るスレ (https://brainbbs.ddns.net/test/read.cgi/edbrain/1455169882/)
- 各記事コメント欄(記事下部)
新しいページを作成
以下のテキストボックスに記事名を入力してください。