編集マニュアル管理 ソースを編集
このページは、 編集フォームと利用者向けマニュアルの対応関係を管理するための 運営者向けページです。
フォーム仕様を変更する場合は、 同じ変更単位でマニュアルへの影響も確認してください。
対応表 ソースを編集
仕様変更時の確認項目 ソースを編集
フォームまたは関連機能を変更するときは、 少なくとも次の項目を確認します。
- 入力項目の追加・削除・名称変更
- 選択肢または選択肢の意味の変更
- 必須・任意の変更
- 入力値の検証条件の変更
- 地図・位置指定・写真登録などの操作方法の変更
- 保存後のページや編集動線の変更
- 詳細Helpへの影響
- 共通説明テンプレートへの影響
- フォーム内の短い案内への影響
更新単位 ソースを編集
フォーム仕様とマニュアルは、 可能な限り同じ変更単位で更新します。
フォームだけを先に変更し、 利用者向け説明が古い状態で残ることを避けてください。
変更前の確認では、
MANUAL_IMPACT_CHECK=PASS
を必須確認項目とします。
一般利用者向けマニュアルに載せない項目 ソースを編集
システム内部でのみ利用する項目は、 一般利用者向けHelpやフォーム案内には記載しません。
現在の代表例:
- sort_order
このような内部項目を追加・変更した場合でも、 一般利用者の操作や表示に影響しない限り 公開マニュアルへ説明を追加する必要はありません。
一方で、内部変更によって 入力方法・表示・保存後の動作などが変わる場合は、 影響するマニュアルも同時に更新してください。