REFERENCE MANUAL SAMPLE
Webシステム リファレンスマニュアル見本
商品登録画面・商品変更画面を例に、画面スナップと説明をセットで見せる、一般的で使いやすいマニュアルのサンプルです。
この見本の構成
- マニュアルの基本ルール
- 画面1：商品登録
- 画面2：商品変更
- 項目説明表のサンプル
FORMAT GUIDE
マニュアルの基本ルール
- 1画面ごとに「目的」「利用タイミング」「画面スナップ」「主要操作」「注意点」を固定化すると、読みやすさが安定します。
- スクリーンショットは画面全体を載せつつ、説明は右側に分離すると、保守資料として流用しやすくなります。
- 注釈は多くしすぎず、1画面あたり3〜5点に絞ると視認性が高くなります。
SCREEN 01
商品登録画面
新しい商品マスタを登録するための画面です。新規採番、基本情報入力、分類設定、保存処理を行います。
商品登録
商品コード*
自動採番
採番
商品名*
有線バーコードリーダー
商品分類*
PC周辺機器
入力機器
仕入先
株式会社サンプル商事
標準単価
4,980 円
公開状態
有効
備考
倉庫Aの定番品。発注点を下回った場合は自動通知対象。
画面スナップ例：商品登録時の入力フォーム全体を掲載
1画面の目的
新規の商品情報を商品マスタへ登録します。必須項目がすべて入力され、登録ボタン押下後に保存処理が行われます。
2主な処理内容
商品コード採番、商品基本情報の入力、分類の選択、公開状態の設定、備考登録を実施します。
3入力チェック
商品名、商品分類、商品コードは必須です。未入力の場合はエラーメッセージを表示し、登録処理は中断します。
4登録完了後
登録成功時は完了メッセージを表示し、商品詳細画面または一覧画面へ遷移する想定です。
OPERATION FLOW
商品登録の操作手順 例
| 手順 | 説明 |
|---|---|
| 1. 商品コードを採番 | 「採番」ボタンを押下し、システムが未使用の商品コードを自動設定します。 |
| 2. 必須項目を入力 | 商品名、商品分類など、必須項目を入力します。必要に応じて仕入先や標準単価も設定します。 |
| 3. 登録する | 「登録する」ボタン押下で入力チェックを行い、問題がなければ商品マスタへ保存します。 |
| 4. 完了メッセージ確認 | 正常終了時は登録完了メッセージを表示します。必要に応じて続けて別の商品を登録します。 |
SCREEN 02
商品変更画面
既存の商品マスタ情報を修正するための画面です。検索・呼出後に、必要な項目のみ更新します。
商品変更
商品コード
PRD-000245
検索
商品名*
有線バーコードリーダー Pro
商品分類*
PC周辺機器
入力機器
標準単価
5,480 円
公開状態
有効
最終更新者
apice.admin
最終更新日時
2026-04-06 16:30
変更理由
仕入価格改定に伴い標準単価を更新。商品名表記を現行カタログに合わせて修正。
画面スナップ例：既存商品を検索して更新する変更フォーム
1画面の目的
登録済み商品の内容修正を行います。商品コード検索後、変更可能項目のみ更新して保存します。
2主な処理内容
対象商品の呼出、項目編集、更新処理、更新履歴の保持を行います。
3注意事項
単価や公開状態の変更は、下流システムや帳票出力に影響する場合があります。変更理由の入力を必須にしてもよい構成です。
4更新完了後
更新成功時は完了メッセージを表示し、最終更新者・最終更新日時を再表示します。
FIELD SPEC SAMPLE
項目説明表のサンプル
| 項目名 | 説明 |
|---|---|
| 商品コード | 商品を一意に識別するコードです。新規登録時は自動採番、変更時は検索キーとして利用します。 |
| 商品名 | 画面表示・帳票出力・検索条件に利用する正式名称です。必須入力項目です。 |
| 商品分類 | 大分類・小分類などの分類体系を設定します。集計や検索条件に利用されます。 |
| 標準単価 | 見積・受注・在庫評価などで参照する基準単価です。必要に応じて小数や税区分ルールを明記します。 |
| 公開状態 | 有効 / 無効などの状態を表します。外部連携や検索対象の可否に影響することがあります。 |
WordPressへ貼り付けるときの使い方
- このまま「カスタムHTML」ブロックへ貼り付ければ、見本として利用できます。
- 実運用では、各画面ごとにスクリーンショット画像へ差し替え、右側説明だけ自社仕様に修正する流れが使いやすいです。
- 見出しルールを「画面概要 / 操作手順 / 項目説明 / 注意事項」で固定すると、複数画面でも統一感が出ます。
商品登録
入力項目の説明
① 商品番号
商品を識別する番号（重複不可）
② 商品名
商品名称を入力
③ カテゴリ
分類を選択
④ 初期在庫数
登録時の在庫数
⑤ 保存
入力内容を登録
商品登録
商品登録
入力項目の説明
- ① 商品番号：一意の番号
- ② 商品名：商品名
- ③ カテゴリ：分類
- ④ 在庫数：初期在庫
商品登録画面｜新しい商品を追加する
新しい商品を在庫管理システムに登録するための画面です。商品名・商品番号・在庫数などの基本情報を入力します。
入力項目の説明
- ① 商品番号： 商品を識別するための番号（重複不可）
- ② 商品名： 商品の名称を入力
- ③ カテゴリ： 商品の分類（例：電子機器、消耗品など）
- ④ 初期在庫数： 登録時点の在庫数
- ⑤ 保存ボタン： 入力内容を登録
操作手順
- 商品番号・商品名を入力
- カテゴリを選択
- 初期在庫数を入力
- 「保存」ボタンをクリック
⚠ 注意
商品番号は一意である必要があります。既に登録されている番号は使用できません。
商品番号は一意である必要があります。既に登録されている番号は使用できません。
商品変更画面｜登録済み商品の編集
登録済みの商品情報を変更するための画面です。商品名やカテゴリの修正が可能です。
変更できる項目
- ① 商品名： 商品名称の変更
- ② カテゴリ： 分類の変更
- ③ 備考： 任意の補足情報
操作手順
- 一覧画面から対象商品を選択
- 内容を修正
- 「更新」ボタンをクリック
⚠ 注意
商品番号は変更できません。変更が必要な場合は再登録してください。
商品番号は変更できません。変更が必要な場合は再登録してください。
コメント