素晴らしいガイドを作成する方法

ユーザーが修理する際に参考となる素晴らしい修理用ガイドを作成するにはこのガイドラインを参照してください。もちろん、修理ガイドは日本語で作成いただけます。

まずやるべきこと ¶ 

===投稿する! ===

どんなガイドでも、無いよりは何千倍もましです。これはルールではなくガイドラインです。ガイドで全てをカバーすることができません。だから私たちは時々遡って必要に応じて再編集をします。私たちは誰しも完璧なガイドを作れません。間違いをします。ガイドは時を重ねてより良いものへと変化していきます。だから最初から完璧なガイドを作る必要はないのです。でも、切り開いていくパイオニアになりましょう!

高質の画像を用意する ¶ 

修理マニュアルが多くの人の目に留まるには、高品質の画像を用意することが大切です。より良い写真を撮影するのは安価な備品さえあれば可能です。実際に撮影する前に少し時間をとって フォト撮影チュートリアルを読んでみましょう。

テキストを補足する画像 ¶ 

画像とテキストは違いに補足しあう関係になります。追加画像はテキストの説明をより詳細に伝えるものです。また逆も同様です。

明瞭に記述する ¶ 

"こと" "部分"や "もの" という曖昧な表現は修理マニュアルの内容をぼんやりとしてしまいます。なんと呼ばれているのか名称を知らない場合は、Googleで調べたり誰かに聞いて確認してください。ガジェットには幾つかの内部で混在しているパーツが幾つかあります。すなわち、伝えたいパーツを"これ" と指すと誰にも伝わりません!

読み手が確認できるように画像を使う ¶ 

作業対象物の位置方向はできるだけガイド上の作業状態と同じにしなければなりません。読み手は画像があると簡単に自分の手元にあるデバイスの位置を確認できます。デバイスを裏返しにする場合は、読み手も同じ作業がしやすいように"デバイスを裏返す"や"時計回りに90度デバイスを回転する"と説明しましょう。

製品情報を最小限にする ¶ 

少しの製品情報であれば良いのですが、考えてみましょう。なぜこガイドを作成しているのか、誰がこのガイドを役に立てるのか、ガイドを準備するために何の準備が必要かということです。でも、あまり深く考えないにしましょう。というのも、インターネット上の人々の多くは何かを修理する前に本で調べて見ることをしないからです。(新しいテレビに付いてきた取り扱い説明書を最後に読んだのはいつか覚えていますか?)

===相互リンクを活用する ===

相互リンクを最大限に活用しましょう。関係する追加情報についてはページ上のどこでもリンクを貼りましょう。

常にトピックに関連した内容にする ¶ 

アイスクリームを自分のバッグの中にいつも潜めているというあなたのおばあちゃんの話はとても好きです。(実話です!)でも、このような話には設定があります。 修理マニュアルのメイントピックはそうではありません。

その事柄について情報源となる ¶ 

より多くの関連情報を追加すると、自分の修理マニュアルに対して権限を強めることができます。

簡潔に、沢山語らないで ¶ 

ユーザーたちはあなたの伝えたいことがよく理解できなければ、あなたの修理マニュアルを利用しません。

===適切に文頭マークを利用します ===

不適切に文頭マークを使用してしまうと大きな混乱を招いてしまいます。各文頭マークを使用する前に、慎重にその置く意味を考えてください。疑問に思うときは、使用しないでおきましょう!

再組み立て用のノートを追加する ¶ 

デバイスの再組み立てが簡単である場合は再組み立て用のノートは不要です。ですが、多くの場合、再組み立て用の特別なインストラクションが必要です。例えば、MacBookのLCDディスプレイを分解する際は簡単ですが、再組み立ての際にワイヤを適切に装着できなければ基板上でワイヤが届かず、接続できないという事態になります。わずかな再組み立て用アドバイスもガイド中に加えると、ユーザーは喜んでくれます。

=== 図解を含める===

同じページ中、画像とテキストのみの組み合わせしかないのでしょうか?幾つかの図解を加えると(画像としてアップロードします)ユーザーはより詳しい修理情報として活用できます。

やってはいけないこと ¶ 

マークアップを過度に使用しない ¶ 

マークアップを過度に追加すると画像が奇妙に見えて、ユーザーに閲覧する気持ちを損なわせてしまいます。伝えたいことが相手が理解できるように追加しましょう。あなたが伝えたいことが伝わるように、必要なだけ追加してください。 4-5センテンス以上のマークアップを追加する場合は、作業の手順を複数に分割することができます。 分からないときは、iFixitのガイドを見てください!

作業タイトルを使いすぎない ¶ 

準タイトルはあまり多く使用してください。 前提条件ガイドを正しく追加できれば、適切なナビゲーション構造が自動的に追加されるため、ほとんどの場合、手順のタイトルは不要です。

一人称を使用しない ¶ 

私たちのチームには "私" 個人は存在しません。ご自分のマニュアルに"私が作りました"という表現を含まない権限のトーンにしましょう。

===自分の意見を他人に押し付けない ===

ここにいるのは他の人たちの修理を手伝うためです。自分の政治的意見やその他個人の意見はこの場所では控えましょう。

消極的な表現を使わない ¶ 

ユーザーにストレートな表現でガイドを作成しましょう。"これは、それはの代名詞"の罠に引っかからないでください。代わりに、伝えたい内容を明確に伝えられるよう動詞を積極的に使用してください。

=== 所有権のない内容をアップロードしない===

あなたのコピーライト所有権がある画像とテキストのみをアップロードしてください。

以下の翻訳者の皆さんにお礼を申し上げます:

100%

Midori Doiさんは世界中で修理する私たちを助けてくれています! 貢献してみませんか?
翻訳を始める ›

統計データを表示:

過去 24時間: 0

過去 7 日: 20

過去 30 日: 179

今までの合計 41,066