メインコンテンツまでスキップ

成果物の編集

成果物を編集する方法は 2 通りあります。簡単な修正や大まかな変更はエージェントによる編集が便利です。細かい調整や正確な文言の修正には手動編集をご利用ください。

エージェントによる編集

エージェントに自然言語で編集内容を指示することで、成果物を自動的に編集できます。

手順

  1. 編集したい内容をエージェントに指示します エージェント編集

  2. 生成された差分を確認して、内容に問題がなければ、変更を適用してドラフトを保存します 差分確認

手動で編集

Markdown 形式で直接編集できます。より細かい調整や正確な文言の修正に適しています。

手順

  1. 編集したい成果物の編集モードボタンをクリックします 手動編集

  2. 編集画面で内容を修正し、チェックボタンをクリックします 編集画面

  3. 差分を確認して、問題がなければ変更を適用してドラフトを保存します 差分確認

手動編集時の注意事項

重要

手動編集では、成果物が内部的に Markdown 形式 に変換されます。テキストとして自由に編集できますが、書式を間違えると記述が消えてしまう可能性があります。編集後は必ず差分を確認してください。

構造の理解

ユースケース要求仕様 の成果物には、以下のような特定の構造が定義されています:

  • ユースケース: 基本フロー、代替フロー、例外フローなどのステップ構造
  • 要求仕様: 上位要求、下位要求、グループ、仕様などの階層構造

この構造に沿って編集しないと、データが正しく解析されず、内容が失われる恐れがあります

安全に編集するためのルール

編集時は以下のルールを守ってください:

  1. 既存の構造を維持する ヘッダーレベル(##, ###, ####)や記号(-, 数字 + .)を変更しないでください

  2. 必須フィールドを削除しない ID、本文、ステップ番号などの必須項目は必ず保持してください

  3. インデントを守る 特にユースケースの代替フロー・例外フロー内のステップは、正しいインデントが必要です

  4. 差分で必ず確認する 編集後は必ず差分を確認し、意図した通りに変換されているか確認してください

危険な編集の例

以下のような編集は避けてください:

❌ 悪い例: ヘッダーレベルの変更

### 基本フロー → ## 基本フロー (階層構造が壊れる)

❌ 悪い例: 必須記号の削除

1. ステップ 1 → ステップ 1 (番号が消えて構造が失われる)

❌ 悪い例: インデントの削除

「 - 代替ステップ」 → 「- 代替ステップ」 (階層関係が失われる)
推奨

構造を変更する大きな編集が必要な場合は、エージェントによる編集の利用をお勧めします。