素晴らしいガイドを作る方法
このガイドラインを活用して、人々が修理するのに役立つ素晴らしい修理ガイドを作成しましょう!
やるべきこと
貢献しよう!
どんなガイドでも、ないよりは千倍ましです。以下はルールではなくガイドラインです。私たちでさえ、すべてを守ることを忘れたり、必要に応じて戻って編集し直したりすることがあります。私たちは皆人間であり、間違いを犯すことを理解しています。これらのガイドは時間の経過とともに改善されていくので、最初から完璧に仕上げなければならないと感じる必要はありません。パイオニアになりましょう!
素晴らしい写真を撮る
優れた写真は、人々を修理ガイドに引きつける最大の要因です。安価な機材でも、素晴らしい写真を撮ることは十分に可能です。撮影の前に、iFixitの写真チュートリアルを学んで時間をかけてみましょう。
写真をテキストで補足する
写真とテキストは互いに補完し合うべきです。追加の写真を使用してテキストの説明を補足し、その逆も同様に行います。
具体的に記述する
「物」、「部品」、「何か」といった曖昧な言葉は、曖昧な修理ガイドにつながります。何という名称か不明な場合は、Googleで検索したり誰かに尋ねたりして、特定するために最善を尽くしてください。ガジェットには複雑な内部部品が複数ある場合があり、「この物」と呼ぶことは誰の助けにもなりません!
写真を使用して読者を導く
ガイド全体を通じて、オブジェクトの向きは可能な限り一定に保つ必要があります。読者は、自分のデバイス上の位置をより簡単に特定できるようになります。オブジェクトを回転させる場合は、「デバイスを裏返す」や「デバイスを時計回りに90度回転させる」といった説明を含めて、読者が同じ操作を行えるようにしてください。
背景情報は最小限に抑える
少しの背景情報は素晴らしいものです。なぜこれを行っているのか、誰がこのガイドから恩恵を受けるのか、ガイドに向けて何を準備する必要があるのか、などです。しかし、それにとどめてください。インターネット上のほとんどの人は、何かを修理する前に本を読むという考えに震え上がります(最後にテレビに付属のユーザーマニュアルを読んだのはいつですか?)。
積極的に相互リンクを貼る
相互リンクは味方です。サイト内の関連リソースへ、可能な限りリンクを貼りましょう。
トピックに関連した内容を保つ
「曾祖母が財布にアイスクリームを入れていた」というような素晴らしい物語は大好きですが(実話です!)、そのような話には適切な場所があります。修理ガイドの途中で語るべきことではありません。
その主題について有益な情報を提供する
関連性の高い情報を追加することで、修理ガイドに信頼性が生まれます。
簡潔に、冗長にならないようにする
何について話しているのか理解できなければ、人々は修理ガイドを使ってくれません。
適切な箇条書きマーカーを使用する
箇条書きを不適切に使用すると、大きな混乱を招く可能性があります。少し時間を取って、使用する前に各箇条書きの意味を確認してください。迷った場合は、デフォルトのものを使用しましょう!
再組み立ての注意点を追加する
デバイスが十分に単純な場合、再組み立ての注意点は必要ないかもしれません。しかし、再組み立てには特別な指示が必要になることもあります。例えば、MacBookの液晶ディスプレイの分解は非常に簡単です。しかし、再組み立て時にワイヤリングを適切に行わなければ、ロジックボードの接続ポイントまで届きません。バラバラになったデバイスを再組み立てできるように役立つヒントを含めると、読者は非常に感謝するでしょう。
図を含める
状況によっては、写真とテキストだけでは不十分な場合があります。図を1つか2つ追加(写真としてアップロード)することで、読者が修理方法を理解する助けとなることは間違いありません。
やってはいけないこと
マークアップを使いすぎない
マークアップを追加しすぎると、読者が写真を見るときに非常に見づらくなります。マークアップが必要だと感じる場合でも、何について話しているかを特定できる程度に留めてください。4~5個以上のマークアップを追加する場合は、作業を複数の手順に分割することを検討してください。迷った場合は、既存のiFixitガイドを参考にしましょう!
手順タイトルを使いすぎない
手順タイトルは控えめに使用してください。必須条件ガイドを正しく追加すれば、適切なナビゲーション構造が自動的に追加されるため、ほとんどの場合、手順タイトルは不要です。
一人称の使用を避ける
チームに「私」という言葉はありません。書くときも同様であるべきです。マニュアル内で「私はこうしました」といった記述を使わないことで、より権威のある口調を保つことができます。
自分の意見を他人に押し付けない
私たちは、物の修理方法を学び合うためにここにいます。政治的見解やその他の個人的な意見は、適切な場所で述べるようにしてください。
受動態を使用しない
ユーザーへの指示は直接的に行ってください。「〜されます」という罠に陥らず、動詞を使用して、伝えたいことを明確に表現してください。
所有していないコンテンツをアップロードしない
自分が所有している、または権利を持っている写真やテキストのみをアップロードしてください。
以下の翻訳者の皆さんにお礼を申し上げます:
100%
Midori Doiさんは世界中で修理する私たちを助けてくれています! あなたも貢献してみませんか?
翻訳を始める ›