電子機器の取扱説明書を作成するための基準はありますか？
電子機器の取扱説明書を作成するための基準はありますか？
デバイスのマニュアルを作成しようとしています。しかし、フォーマットが見つかりませんでした。見つけたら、これをガイドとして持っていきます。
標準がない場合、マニュアルに何を含めるべきか、または何を含めるべきではありませんか？
マニュアルには、以下を含むがこれらに限定されない、デバイスの所有者が知る必要のあるすべてのものが含まれている必要があります。
- 解凍：解凍方法
- 操作：操作方法
- 統合：必要に応じて、他のデバイスと組み合わせて使用する方法
- Care：世話をする方法
- サプライ品：デバイスが必要とするサプライ品の入手先
- トラブルシューティング：機能していないように見える場合の対処方法
- Service：修理が必要な場合の連絡先
- 安全性：必要な安全性情報
- リサイクルと廃棄：責任を持ってそれを取り除く方法
- 保証：保証書と免責事項またはその他の法的文書
- インデックス：完全なインデックス
デバイスの使用が複雑な場合、および/またはユーザーがまだ知識を持っていることが期待されていない場合は、いくつかの例を含めることをお勧めします。
一般的なマニュアル作成の標準については知りませんが、特定の市場向けにいくつか存在していると確信しています。たとえば、軍隊への販売を計画している場合、特定の基準を満たすマニュアルを提供する必要があることは容易に想像できます。また、特定の国では、その国の公用語でマニュアルを提供する必要がある場合があります。
アイデアについては、車、ブレンダー、ステレオ、DVR、プリンター、電子レンジ、および家の周りにあるその他のデバイスに付属のマニュアルを参照してください。
これが私がお勧めするものです：
- IPhoneまたはiPodのボックスとマニュアルを手に取り、
- デバイスとコンテンツに応じてセクションを複製します。
（お使いのデバイスのタイプに近いデバイスを選択する方が適している可能性があります。私は、そのようなことを適切にサポートしている例を挙げました。）
いくつかの異なる基準があります：
- MIL-STD-498
- IEEE 12207-2008
- 実施段階の文書化基準 （香港政府基準）
一般的なフォーマット：
- 必要なバージョン情報と作成者および発行者の詳細が記載されたフロントページコンテンツページ
- システムの範囲と目的に関する一般的なビジネス
- マニュアルの範囲と目的の概要
- 機能とそのハードウェアおよびソフトウェア要件を含むソフトウェアの一般的な概要
- ソフトウェアの全体像を重視する一般ユーザー
- スタートアップガイド、カバー：インストール、セットアップ、初回使用、デフォルトのパスワードなど
- 参照を処理し、システムが可能なすべての操作を実行する際にユーザーをガイドします
詳細については、MIL-STD-498を参照してください。