設定者が残すべきドキュメントの内容と作成のポイント

「楽楽販売」の設定者が作成すべきドキュメントには、主に「管理者向け引継ぎ資料」と「利用者向け操作マニュアル」の2つの方法があります

「楽楽販売」はノンプログラミングで自由にカスタマイズできるため、設定の意図や構造がブラックボックス化しやすい側面があります。
後任の担当者がスムーズにメンテナンスを行えるようにするための「管理者向け」の資料と、現場のユーザーが迷わず操作できるようにするための「利用者向け」の資料を、用途に合わせて準備してください。

最適な構築手法の選び方・判断基準

後任の管理者にシステムの構造を伝えたい場合
➔ 1. 管理者向け引継ぎ資料の作成が適しています。データベースのつながりや自動処理のロジックなど、システムの全体像を網羅的に記録することで、担当者交代時のリスクを最小限に抑えられます。

現場のユーザーに正しい操作方法を周知したい場合
➔ 2. 利用者向け操作マニュアル（社内教育資料）の作成が適しています。実際の画面キャプチャを用いた手順書を用意することで、ユーザーの自己解決を促し、管理者への問い合わせ工数を削減できます。

システム内に直接設定の意図を残したい場合
➔ 3. コメント機能と「DB構成可視化」の活用が適しています。ドキュメントを別途作成する負担を軽減しつつ、設定画面上で直接「なぜこの設定にしたか」を確認できるため、日々のメンテナンスに非常に有効です。

各手段の詳細と設定手順

1. 管理者向け引継ぎ資料の作成（システム全体像の記録）

＜メリット＞
データベース間のリレーションや自動処理の複雑な条件など、目に見えにくい「設計の意図」を確実に引き継ぐことができます。

＜デメリット＞
システムの変更に合わせて資料を更新し続ける運用負荷が発生します。

【作成すべき内容】
下記の内容を盛り込んだ資料を作成してください。サポートサイトにてパワーポイント形式のフォーマットも提供しています。

・データベース構成：
 　作成されている各データベースの役割と、データベースリンクによるつながり。

・各データベースの詳細：
　どのような手順で利用されるか、どのような自動処理が設定されているか。

・メンテナンス箇所：
　定期的なデータ削除や、年度更新が必要な設定（営業日カレンダーなど）。

・導入背景：
　そもそも何を解決するためにこの構成にしたのかという定性情報。

2. 利用者向け操作マニュアル（社内教育資料）の作成

＜メリット＞
ユーザーが「次に何をすべきか」を迷わなくなるため、データの登録ミスや漏れを未然に防ぐことができます。

＜デメリット＞
画面レイアウトを変更するたびにキャプチャの撮り直しが必要になります。

【作成の手順】
1. 業務フローを図にする： どの作業を誰が行うか、一連の流れを可視化します。
2. 画面キャプチャを活用する： 実際の「楽楽販売」の操作画面を撮影し、入力すべき項目やボタンの位置を明示します。
3. 運用ルールを明記する： 「この項目は必ず半角で入力する」といった、システム設定だけでは制御しきれない運用上の約束事を記載します。

3. 自動処理パーツのコメント欄やメニューの上下メッセージに設定意図を直接記録する

＜メリット＞
設定画面を開いた際にその場で補足情報を確認できるため、ドキュメントを探す手間が省けます。また、操作画面を録画して共有することも有効な手段です。

＜デメリット＞
記述できる文字数に限りがあるため、複雑な全体図の解説には向きません。

【設定箇所】 各データベース設定＞機能設定＞自動処理設定 ／ 基本設定＞メニュー設定

【設定手順】
◆1. 自動処理パーツの名前とコメント：
各パーツの「名前変更」から、単なる「レコード更新」ではなく「受注ステータスを完了に変更する」といった具体的な名前に変更し、コメント欄に「〇〇条件の時のみ実行される」といったロジックの意図を記載します。

◆2. メニューの上下メッセージ：
一覧メニューや入力メニューの「全体設定」にある「上部メッセージ」「下部メッセージ」を活用し、画面上に「この画面では〇〇の入力を完了させてください」といった操作ガイドを直接表示させます。

◆3. 「DB構成可視化」機能の利用：
 管理者設定＞メンテナンス機能＞DB構成可視化 より、現在のデータベース構造や自動処理のフロー図をいつでも確認・JSON形式で出力できるようにしておきます。

関連マニュアル

詳細な仕様の違いや作成手順については、下記記事をご確認ください。

管理者向けの引継ぎ資料フォーマットと準備事項

担当者交代時に最低限引き継ぎたい内容のリストや、パワーポイント形式のフォーマットをダウンロードできます。
システム安定稼働のための事前準備

社内教育資料（マニュアル）の作り方とひな形

利用者向け説明会を実施する際の手順や、マニュアル作成に便利なスライド資料のテンプレートをご案内しています。
社内教育資料の作り方

DB構成や自動処理のフローを視覚的に把握する方法

作成したデータベースの構造や自動処理のつながりを画面上で確認し、仕様書として活用する手順を解説しています。
DB構成可視化

（記事ID：2641）