マニュアル

マニュアルは、アプリ群の使い方や業務の運用手順を社内向けにまとめる文書機能です。 raxel 自体の使い方 (このヘルプ) とは別に、「自社ではこのアプリをどう使うか」「月初に誰が何をするか」といった自社固有の手順を、利用者がアプリ画面から迷わず開ける形で置いておけます。 作成・編集はシステム管理 → コンテンツ → マニュアルで行い、閲覧は各アプリの画面から辿れます。

構成と権限

  • ブック → 章 → ページの 2 階層で構成します (1 ブック最大 200 ページ・本文合計 300 万字、1 環境に最大 200 ブック)
  • 各ページにアンカー (「このページが説明するアプリ」) を付けます。アンカーは 1 ページに最大 8 つまでで、アプリ画面からの導線・閲覧できる人・パッケージへの同梱はすべてこのアンカーから決まります
  • 作成・編集・削除・並べ替えができるのはシステム管理者だけです。一般メンバーは閲覧のみです
  • 一覧の各ブックには更新日とページ数が添えられます (同じタイトルのブックが並んでも見分けられます)
  • アンカー先のアプリがすべて削除されたブックには「参照先のアプリがありません」の警告が付きます (パッケージをアンインストールした後に、手書きのマニュアルが残った場合など)。そのままでは管理者にしか表示されず、フォームプレビューも描画されないので、ページを編集してアンカーを付け直すか、ブックをゴミ箱へ移してください
ブックの状態
アンカー先アプリのどれか 1 つにアクセスできる
閲覧できる人
そのメンバーに表示されます (関係のないアプリのマニュアルは表示されません)
ブックの状態
どのページにもアンカーが無い
閲覧できる人
全メンバーに表示されます (全社共通のドキュメント向け)
ブックの状態
アンカー先のアプリがすべて削除された
閲覧できる人
システム管理者にだけ表示されます (孤児になりません)

作る — 編集画面

ブックを選んで「編集」を押すと、ブック全体をひとつの編集画面で扱います。ページの追加・並べ替え・章立て・アンカーの付け替えを行い、 画面下部に常時表示される保存ボタンでブック全体を一括保存します (途中でやめるときは「キャンセル」)。 別の管理者が同時に同じブックを保存した場合は、後から保存した側に「更新されています」と表示され、上書きは起きません。

本文に使えるもの

部品
見出し (大 / 小)・本文・箇条書き・番号つきリスト
使い方
ツールバーの「スタイル」から選びます。見出しは読み手の目次には出ませんが、ページ内の構造として使えます
部品
表
使い方
手順の対応表や役割一覧に。読み手側では横に長い表が自動で横スクロールになります
部品
注記ボックス (情報 / 注意 / 危険 / 成功)
使い方
「スタイル」から選びます。「例外」「やってはいけないこと」の強調に
部品
コードブロック
使い方
計算式や設定値の原文など、そのまま写してほしいもの
部品
アイコン
使い方
ツールバーのアイコンボタンから挿入 (時計・カレンダー・注意など)
部品
画像
使い方
画像ファイルを貼り付けるか、ツールバーの画像ボタンからアップロードします。画像はマニュアルの添付として保存され、環境のディスク使用量に計上されます
部品
フォームプレビューの埋め込み
使い方
ツールバーのフォームボタンでアプリを選ぶと、そのアプリの入力フォームの見取り図が本文に入ります。「強調する項目」を選ぶと、その項目が枠で囲まれ他は薄く表示されます (項目名は完全一致)。各入力欄の中には、フィールド設定のプレースホルダ (無ければ型ごとの入力例)、既定値があればその値が見本として入り、計算・集計・自動採番・参照値のように利用者が入力しない項目は破線 + 「(入力不要)」で示されます。埋め込むときに項目ごとの入力例を書いておくと、その手順で実際に入れる内容 (「早番」「09:00 〜 18:00」など) が「入っている値」として表示され、読み手はページの文脈に沿った例を見られます。サブテーブルは「列は | 、行は ; で区切る」書き方で複数行の例を入れられます (例: 「社内システム刷新 | 設計レビュー | 120; 全体 | 打合せ | 60」)。見取り図は実際のフォーム定義からその場で描画されるため、フォームを変えてもマニュアル側は常に最新です
部品
元に戻す / やり直す
使い方
ツールバーの矢印ボタン (キーボードショートカットも可)

フォームプレビューは、そのアプリを閲覧できる読み手にだけ実体が表示されます。閲覧権限のない読み手には「権限がありません」の枠だけが出ます。 項目数の多いフォームは冒頭だけを表示し、「残り N 項目を表示」で読み手がその場で展開します。

読む — 利用者から見た画面

  • アプリ詳細ヘッダーの本のアイコン: そのアプリをアンカーに持つブック・ページが一覧され、クリックすると該当ページを直接開きます (マニュアルがあるアプリにだけ表示されます)
  • スペースページ: スペース内のアプリに関係するマニュアルが並びます
  • システム管理 → コンテンツ → マニュアル: すべてのブック (閲覧できるもの) を一覧で開けます
  • 左の目次は画面のスクロールに追随し、章は折りたたんで読めます (開いているページを含む章は自動で開きます)
  • 目次の上の検索欄で、そのブックの全文を検索できます (ページ名と本文が対象。ヒット箇所の抜粋つき)
  • 各ページの上部に、そのページのアンカー先アプリがチップで表示され、クリックするとアプリへ移動できます

守る — ゴミ箱・変更履歴・監査ログ

ゴミ箱

ブックを削除するとゴミ箱に移動します。システム管理者はマニュアル画面の「ゴミ箱」から 30 日以内であればページ・画像ごと復元でき、 30 日を過ぎると画像も含めて自動的に完全削除されます。ゴミ箱から「完全に削除」を選ぶと即時に消えます。

変更履歴 (版)

ブックを保存するたびに、保存後の内容が版として残ります (直近 20 版)。ブックの「変更履歴」を開くと版の一覧 (版番号・日時・保存した人・ページ数) が見え、 誤って書き換えてしまった場合は「この版に戻す」で以前の内容に戻せます。戻す操作もひとつの保存として版に残るため、戻し過ぎてもまた戻せます。

  • 版が参照している画像は、その版が残っている間は保持されます (窓の中では画像込みで元どおりに戻ります)
  • パッケージに同梱されて導入されたブックなど版管理より前から存在するブックは、最初の保存で保存前の内容が第 1 版として自動記録されます。最初の編集が誤りでも戻る先があります
  • 版の削除: 特定の版を消したいとき (誤って貼り付けた内容がその版にだけ残っている、など) は版ごとに削除できます。最新の版 (= 今の内容) は削除できません
  • 履歴の消去: 「履歴をすべて消去」で過去の版をまとめて消せます。消去直後に今の内容が新しい版として記録し直されるので、戻る先が無くなることはありません
  • 古い版が消えた版の内容は復元できません。版の削除と履歴の消去は取り消せない操作なので確認ダイアログが出ます

監査ログ

マニュアルの作成・更新・ゴミ箱への移動・復元・完全削除・版への復元・版の削除・履歴の消去は、 誰が・いつ・どのブックに対して行ったかが監査ログに記録されます (IP アドレスつき)。 AI エージェント経由の変更は経路が区別して記録されます。

パッケージとの関係

  • 業務パッケージ (例: 勤怠) を導入すると、そのパッケージのハンドブックがスクリーンショット込みで一緒に作成されます。自社に合わせて書き換えて構いません (第 1 版に戻せます)
  • 同じタイトルのブックが既にある状態でパッケージを再導入すると、新しいハンドブックのタイトルに導入日が付きます (例: 「… (2026-09-06 導入)」)。古い方はパッケージのアプリを参照したままなので、内容を移し終えたらゴミ箱へ移してください
  • 自社のアプリ群を「テンプレートとして保存」して別環境に導入する場合、アンカー先がすべて書き出し対象に含まれるブックが画像ごと同梱されます
  • パッケージをアンインストールすると、同梱されていたブックも削除されます

AI エージェントと連携する

AI エージェント連携 (MCP) のトークンに設定ツールの権限を付けると、AI からマニュアルを読み書きできます。 「アプリを納品するときにマニュアルまで揃える」「アプリ設定の変更に合わせてマニュアルを追随させる」といった使い方を想定しています。

ツール
get_manuals
内容
接続範囲のアプリにアンカーされたブックを取得します。接続範囲外のアプリへのアンカーを含むブックは編集不可 (保護) として返ります
ツール
set_manuals
内容
ブックを作成・更新します (全量置換)。既存ブックを落とす・ページ数が減る送信は削除件数の申告がないと拒否され、削除はゴミ箱行きです。
dryRun
で保存せずに検証だけ実行できます
ツール
get_manual_writing_context
内容
執筆ガイド (章立ての型・書き方の規約) と、対象アプリの設定ダイジェスト (フィールド・計算式・ワークフロー・通知・権限の構造)、既存マニュアルの本文を執筆素材として返します。AI の呼び出し自体には raxel の AI クレジットを消費しません
  1. AI に「勤怠パッケージのマニュアルを書いて」と頼むと、AI は 
    get_manual_writing_context
    で素材を集め、ガイドに沿って本文を組み立てます
  2. set_manuals
    の 
    dryRun
    で検証してから保存します
  3. 保存はすべて版として残り、監査ログにも記録されるので、AI が書き換えた内容も人と同じ手順で確認・巻き戻しができます