最低限のビルドガイドのテンプレ（仮）

/icons/hr.icon

タイトルページ

タイトル

キーボードの正式名称，ビルドガイドであること，バージョン・リビジョン・この版の日付を示す．

購入者から問い合わせを受けたときに，購入者が見ているドキュメントのバージョンを知るために必要．

例

hoge キーボード ビルドガイド

Rev.B (2020-01-01)

変更履歴

過去のガイドから変更のあった分を書く．

例

2019-01-01 Rev.A

2020-01-01 Rev.B 基板の配線を一部変更

2020-01-05 fuga についての記述を追加

/icons/hr.icon

組立てを始める前の準備

キーボードの特徴

簡潔にキーボードの概要を書く．

購入者がキーボードの全体像と，完成時に得られるものについてある程度想像がつくようにする．

例

hoge キーボードは「hoge」という単語の入力に特化した 4 キーのマクロパッドです．マトリクスを介さずMCUとスイッチを直結することで，高速かつ低レイテンシで「hoge」という単語を入力することができます（実際のレイテンシはUSBホスト側にも影響されます）．

使用上の注意・FAQ

自作キーボードに関する知識が必要なキーボードであることと，得られるサポートの範囲を書く．

FAQもこのあたりに書いておくとよい．

例

本キットは，自作キーボードについての適切な知識のある方を対象としています．

製品には，一部鋭利なパーツや壊れやすいパーツがありますので，注意して扱ってください．

ファームウェア開発や，開発環境の構築はサポート外です．

後述のように，組立前に初期不良を確認してください．不具合が発見された場合，商品到着後 XXX 以内に購入先へご連絡ください．

キット以外に必要な部品・工具

購入者が別途用意すべき部品の一覧・型番を表形式で書く．

/icons/hr.icon

内容物と動作の確認

付属品の一覧

付属品の一覧を写真と表で示す．

「組立手順」の画像と対応するように，付属品の一覧（画像）にアルファベットなどで記号を振っておく．

動作確認

基板単体で動作確認が可能な場合，動作確認の方法を示す．

/icons/hr.icon

組立手順

ステップごとに画像を示す．

部品を取り付ける場所に，内容物の「付属品の一覧」と同じ記号を振っておくとよい．

/icons/hr.icon

完成品の動作確認

Pro Micro を使用するキーボードでは動作確認が可能なのは組立後なので，動作確認の方法をここに書く．