ドキュメントの基本的な使い方

ドキュメントは、文字の装飾や画像の添付ができるリッチテキストツールです。複数人での同時編集も可能なので、効率よくテキストコンテンツを作成できます。

ドキュメントの基本的な使い方について説明します。

ドキュメントを閲覧する

ドキュメントアイコンをクリックします。

メニューから「ドキュメント」を選択している様子

初めてドキュメント機能を開くと「ドキュメント機能へようこそ」というガイドページが表示されます。
すでに複数のドキュメントが作成されているプロジェクトでは、ドキュメント一覧の一番上のドキュメントが表示されます。

ドキュメントが複数ある場合は、ドキュメントのサイドメニューより該当のドキュメントをクリックすると、該当のドキュメントへ遷移します。

「ドキュメント」一覧を表示している様子

ドキュメントを追加する

ドキュメントを追加する手順を説明します。

  1. ドキュメントのサイドメニューにある「+」をクリックします「ドキュメントを追加」ボタンを選択している様子
  2. ドキュメント編集画面が表示されるので、テキストを入力します
  3. 「編集を終了」をクリックします

階層構造でドキュメントを追加する

ドキュメントは階層構造で整理できます。

階層構造でドキュメントを追加する場合は、ドキュメントのサイドメニューから、該当するドキュメントの「この下にドキュメントを追加」をクリックしてください。

階層構造でドキュメントを追加する様子

ドキュメントを編集する

「編集」をクリックすると、ドキュメントの編集が行えます。編集ボタンを選択している様子

リッチテキストを使用する

リッチテキストを使用して、ドキュメントのデザインやレイアウトを調整できます。

ツールバーを使用して、以下の操作を行うことができます。

  • 見出し、太字、斜字、下線、打ち消し線、テキストの色、色
  • テキストの配置
  • 箇条書きリスト、番号付きリスト、チェックリスト
  • リンク、ファイルを添付、テーブル、引用、インラインコード、コードブロック、区切り線
  • 書式をクリア

ドキュメント編集画面が表示されている状態のスクリーンショット。リッチテキストのツールバーが強調されている

スラッシュコマンドを使用する

ドキュメントの編集中に「/」を入力すると、以下のメニューを利用できます。

  • 見出し1、見出し2
  • 箇条書きリスト、連番リスト、チェックリスト
  • 引用、区切り線、ファイルを添付、コードブロック、コードブロック - マーメイド、コードブロック - PlantUML、リンク
  • コールアウト、ドキュメントリスト、目次、折りたたみセクション

スラッシュコマンドのメニューを表示

また、「/」の後ろにメニュー名を入力すると、メニューを絞り込めます。

スラッシュコマンドメニューの絞り込みを表示

「@コマンド」を使用する

ドキュメント本文で半角の「@」を入力すると、日付、メンバー、課題、ドキュメント、共有ファイルなどをダイアログから挿入できます。

Backlogのドキュメントで、@コマンドのダイアログが表示されている状態のスクリーンショット。「お知らせを送る」と「プロジェクトをまたぐ」が赤枠で強調されている

 

・メンバーを選択すると、選択したメンバーにBacklog上でお知らせが送られます。通知を送りたくない場合は、ダイアログのメンバー欄にある「お知らせを送る」を無効にしてください
・ダイアログの最下部にある「プロジェクトをまたぐ」を有効にすることで、別のプロジェクトの情報も挿入できます

課題の作成をする

課題にしたいテキストを選択した際に表示されるメニューで「課題を追加」を選択すると、ドキュメント上で課題を作成できます。

Backlogのドキュメントで、テキストを選択すると表示されるメニューが表示されている状態のスクリーンショット

タグ機能を利用してグルーピングする

タイトル上部に表示される「タグを設定」からタグを追加、または選択することで、関連するドキュメントをグルーピングできます。

また、検索結果をダイアログで表示できます。

Backlogのドキュメントで、タグのダイアログが表示されている状態のスクリーンショット

目次の表示有無を設定する

ドキュメントの目次は、見出しを設定すると自動で作成されます。目次の表示は設定で切り替えられます。

目次の表示有無を設定する際の手順を説明します。

  1. 該当のドキュメントの三点リーダーをクリックします
  2. 「目次を表示」をクリックします

Backlogのドキュメントで、三点リーダーをクリックした際に表示されるメニューのスクリーンショット。三点リーダーと「目次を表示」が強調されている

本文の横幅を拡大する

本文の横幅を拡大する設定をし、本文の幅を最大まで広げられます。

本文の横幅を拡大する設定をする手順を説明します。

  1. 該当のドキュメントの三点リーダーをクリックします
  2. 「本文の横幅を拡大」をクリックします

Backlogのドキュメントで、三点リーダーをクリックした際に表示されるメニューのスクリーンショット。三点リーダーと「本文の横幅を拡大」が強調されている

 

複数メンバーで同時編集する

ドキュメントは複数メンバーが同時に編集できます。編集しているメンバーはアイコンで表示されます。

Backlogのドキュメントで、編集画面が表示されている状態のスクリーンショット。ドキュメントを編集しているメンバーのアイコンが強調されている

同時編集できる人数には制限があります。詳しくはプランごとの使用上限を参照してください。

ドキュメントを保存する

ドキュメントを保存する場合は、該当のドキュメントの「保存して終了」をクリックします。Backlogのドキュメントで、編集画面が表示されている状態のスクリーンショット。「編集を終了」ボタンが強調されている

編集画面で3秒以上操作がない場合、ドキュメントは自動で保存されます。

ドキュメントを検索する手順を説明します。

  1. 「ドキュメントを検索」をクリックします
    検索フィールドを表示
  2. 「キーワードを入力」に、検索するキーワードを入力します
  3. 検索結果の一覧が表示されます。キーワードに該当した箇所は、ハイライト表示されます。検索結果をクリックすると、該当のドキュメントに遷移します検索結果を表示

コメントを使用する

ドキュメントには、コメントをつけることができます。

コメントを追加する

テキストにコメントを追加する手順を説明します。

  1. コメントしたいテキストをドラッグします
  2. 「コメント」をクリックします
    コメントの追加リンクを表示
  3. コメントを入力し、「登録」をクリックします
    コメントの入力エリアを表示

コメントが追加されます。コメントしたテキストに背景色がつき、コメントしたユーザーのアイコンが吹き出しで表示されます。

コメントしたユーザーのアイコンの吹き出しを表示

コメントを確認する

コメントを確認する方法を説明します。

特定のテキストのコメントを確認する

テキストの横に表示されている吹き出しをクリックすると、コメントが表示されます。

吹き出しからコメントを表示

ドキュメント内のすべてのコメントを確認する

「コメントを表示」をクリックします。

コメントアイコンを表示

すべてのコメントが表示されます。

すべてのコメントが表示された様子

コメントに返信する

コメントに返信する手順を説明します。

  1. 該当のコメントをクリックします
  2. 「コメントへ返信する」に入力します
  3. 「登録」をクリックします

コメントの登録画面を表示

コメントを編集する

コメントを編集する手順を説明します。

  1. 該当のコメントの三点リーダーをクリックします
  2. 「コメントを編集」をクリックします
    コメントの編集リンクを表示
  3. 内容を編集し「登録」をクリックします

コメントを削除する

コメントを削除する手順を説明します。
コメントを削除できるのは、コメントを追加した本人のみです。

  1. 該当のコメントの三点リーダーをクリックします
  2. 「コメントを削除」をクリックします
    コメントの削除リンクを表示

コメントのURLをコピーする

コメントを編集する手順を説明します。

  1. 該当のコメントの三点リーダーをクリックします
  2. 「URLをコピー」をクリックしますコメントのURLのコピーを表示

コメントのステータス

コメントにはステータスがつけられます。状況に応じてステータスを変更してください。

ステータス 説明 「コメントを表示」の通知バッジのカウント テキストの背景色
未解決 コメントのやり取りが続いている状態 カウントされる 表示される
解決済み コメントのやり取りが完了した状態 カウントされない 表示される
解決済みで非表示 コメントのやり取りが完了した状態 カウントされない 表示されない

コメントのステータスを変更する

コメントのステータスを変更する手順を説明します。

  1. ステータスを変更するコメントをクリックします
  2. セレクトボックスより、変更するステータスを選択します
    コメントのステータスを変更する様子
  3. 「コメントへ返信する」に入力します
  4. 「登録」をクリックします
    コメントの登録画面を表示

「解決済みで非表示」にしたコメントを再開する

「解決済みで非表示」にしたコメントは、ドキュメント上で確認ができません。そのため、再度確認する場合はコメントの再開をしてください。

「解決済みで非表示」にしたコメントを再開する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「解決済みで非表示のコメント」をクリックします
    「解決済みで非表示のコメント」リンクを表示
  3. 再開したいコメントの三点リーダーをクリックします
  4. 「コメントを再開する」をクリックします
    「コメントを再開する」リンクを表示

変更履歴を使用する

ドキュメントでは変更履歴を確認できます。変更履歴は、ドキュメントが保存されたタイミングで自動で作成されます。

変更履歴を確認する

変更履歴を確認する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「変更履歴を表示」をクリックします
    「変更履歴を表示」リンクを表示

バージョン管理をする

変更履歴の特定のタイミングを、バージョンで管理できます。

バージョン管理する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「現在のバージョンを保存」をクリックします
    「現在のバージョンを保存」リンクを表示
  3. 「バージョン名」を記入し、「保存」をクリックします
    バージョンの保存画面を表示

ドキュメントの並べ替えをする

ドキュメントのサイドメニューからドキュメントをドラッグアンドドロップすると、ドキュメントの並べ替え、階層化ができます。

最大の階層数は21階層までです。

ドキュメントをコピー・複製する

URLをコピーする

ドキュメントのURLをコピーする手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「URLをコピー」をクリックします
    「URLをコピー」リンクを表示

複製する

ドキュメントを複製する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「複製」をクリックします
    「複製」リンクを表示

インポートする

最大10個のファイルを一度にインポートできます。
ドキュメントをインポートする手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「インポート」をクリックします Backlogのドキュメントの画面で、三点リーダーをクリックしたスクリーンショット。「インポート」が赤枠で囲われ強調されている。
  3. ファイルをドラッグアンドドロップ、または「ファイルを選択」ボタンをクリックします

ファイルをアップロードすると、インポートが自動で開始されます。インポートに成功すると、「n個のファイルをインポートしました。」のダイアログが画面右下に表示されます。

・インポートした内容は、新しいページとして、インポート時に開いていたドキュメントの下に追加されます。
・インポートしたファイルの名称がドキュメントの名称としてインポートされます。
・複数ファイルをまとめてインポートする場合、1ファイル1ページでインポートされます。

・インポートできるファイルの拡張子は .md, .markdown, .txtです。
・インポートできるファイルの最大サイズは、1MBです。
・Data URI形式など、特定の形式を含むファイルのインポートはできません。

エクスポートする

ドキュメントをエクスポートする手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「エクスポート」をクリックします
    「エクスポート」リンクを表示
  3. 「形式」を選択します
  4. 「エクスポート」をクリックすると、選択した形式でダウンロードが開始します
    形式を選択し、エクスポートをする様子

「クリップボードにコピー」ボタンをクリックすると、選択した形式でドキュメントの内容がクリップボードにコピーされます。 クリップボードにコピーする様子

ドキュメントを削除する

ドキュメントの削除には、「ゴミ箱へ移動」と「完全に削除」の2つがあります。

ゴミ箱にあるドキュメントは、いつでも元に戻せます。完全に削除したドキュメントは、元に戻すことはできません。

ゴミ箱へ移動する

ドキュメントをゴミ箱へ移動する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「ゴミ箱へ移動」をクリックします
    「ゴミ箱へ移動」リンクを表示

ドキュメントのサイドメニューの「ゴミ箱」へ移動します。

ドキュメントがゴミ箱へ移動された様子

ゴミ箱にあるドキュメントは編集できません。編集するには、復元する必要があります。

復元する

ゴミ箱へ移動したドキュメントは、復元すると元の場所に戻ります。

ドキュメントをゴミ箱から復元する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「復元」をクリックします
    「復元」リンクを表示

完全に削除する

不要なドキュメントを完全に削除できます。

管理者、プロジェクト管理者の権限をもつメンバーが使用できます。

削除したドキュメントは元に戻せません。削除したいドキュメントに間違いがないか確認のうえ操作を行ってください。

ドキュメントをゴミ箱から削除する手順を説明します。

  1. ドキュメントの三点リーダーをクリックします
  2. 「完全に削除」をクリックします
    「完全に削除」リンクを表示