モデル・画面に対応する操作マニュアルを用意する

業務アプリの利用者向けに、目的別の操作手順を用意し、分類・目次・検索のあるHTMLとして提供できます。

最終更新日：2026年10月30日

プロダクトツアー・操作マニュアルの小目次へ

1. このページで伝える機能

業務アプリの利用者向けに、目的別の操作手順を用意し、分類・目次・検索のあるHTMLとして提供できます。

2. Wagby11で実現できること

日報を探す、日報を登録する、といった操作目的ごとに原稿を作る例です。画面の一部分を順に案内するツアーに加え、操作前の準備や入力エラー時の確認事項を、まとまった説明として読めます。

原稿から生成した「日報を登録する」の操作マニュアルです。ページ内目次と手順を表示します。

キーワードで検索すると、該当するページのある分類だけを表示します。検索語を消すと目次全体に戻り、該当するページがない場合はその旨を表示します。

ページには「この操作でできること」「操作する前に」「手順」「操作後の確認」「うまくいかないとき」「関連する操作」を用意します。実際の画面名・項目名・ボタン名を使い、一つの番号付き手順に一つの操作を書きます。利用者が設計用語を覚えなくても操作できる文章にします。

原稿はMarkdown、分類や並び順は操作マニュアル専用の設定で管理します。AppSchemaとは独立した設計ファイルですが、モデルの存在などを照合してHTMLを生成します。原稿には画像や関連ページへのリンクも掲載できます。

モデルや画面を変更したら、対応する説明と手順も更新して再生成します。生成済みHTMLを直接編集せず、原稿を正として管理します。操作マニュアルはログオンした利用者が閲覧するため、閲覧者全員へ公開できる説明を掲載します。

3. AIへの指示例

最小限の指示例

日報の検索と登録の操作マニュアルを作ってください。

AIはページの分け方、目次の分類、事前準備、操作手順、困ったときの説明を類推して補います。対象の利用者と、画面上でどの操作まで案内するかを伝えます。

より詳細な指示例

一般利用者向けに、日報管理の使い方・日報を探す・日報を登録する、の3ページを作成してください。user-manual配下のMarkdownとmanual.yamlで管理し、日報の分類にこの順で並べます。登録は日付・件名・内容の入力と保存、登録後の確認、必須入力漏れの対処を説明してください。モデル・画面名と実画面を照合し、原稿を検証してHTMLへ生成してください。
既存の定義・データ・権限を保持し、Wagby11のguide・referenceを確認してください。生成・ビルド後、対象利用者でツアーと操作マニュアルの動作を確認してください。

4. 編集されるAppSchemaの例

以下は関連する定義の抜粋です。構文を覚えなくても、案内する操作・説明文・表示する条件をAIへ伝えられます。

# user-manual/manual.yaml の構成例
version: 1
default_locale: ja
site:
  title: 業務アプリ 操作マニュアル
locales:
  ja:
    sections:
      - id: dailyreport-help
        title: 日報
        documents:
          - ja/dailyreport-help/overview.md
          - ja/dailyreport-help/search.md
          - ja/dailyreport-help/create.md

操作マニュアルの原稿と設定はAppSchemaとは独立しています。ここではAppSchemaの変更ではなく、AIが用意する操作マニュアル側の設定を示しています。各Markdownのcontextsで、対応するモデルや画面を指定します。

操作ページの原稿例

次は「日報を登録する」の原稿例です。画面との対応に続けて、利用者向けの手順を記述します。

---
id: dailyreport-create
summary: 日付、件名、活動内容を入力して日報を登録し、登録後の内容を確認する方法を説明します。
contexts: [entity.MobileReport.create]
keywords: [日報, 登録, 必須入力]
audience: general
---
# 日報を登録する

## この操作でできること
日付、件名、活動内容を日報として登録できます。

## 操作する前に
報告する日付と活動内容を用意します。

## 手順
1. メニューから「日報を登録する」を選択します。
2. 日付を入力します。
3. 件名を入力します。
4. 内容を入力します。
5. 「保存」を選択します。

## 操作後の確認
表示された詳細画面で、日付、件名、内容を確認します。

## うまくいかないとき
必須の日付と件名が未入力の場合は、入力して保存し直します。

## 関連する操作
- [日報を探す](search.md)
- [日報管理の使い方](overview.md)

5. 参考資料

操作マニュアル: designer/docs/appschema/html/guide/12-user-manual/index.html
操作マニュアル設計ファイル: designer/docs/appschema/html/reference/19-user-manual.html