コンテンツにスキップ

文書を扱う

文書(Documents)は、プロジェクトの書かれた成果物です。PRD、仕様、設計、メモ、そして完了レポートなどです。ほとんどは提案を承認したときに自動で作られますが、手で書くこともできます。本ページは、文書一覧、文書の作成と編集、バージョン履歴、レポートがどう現れるか、そして文書の削除を扱います。

プロジェクトサイドバーで Documents を選ぶと、プロジェクトの文書がカードのグリッドとして見え、各カードはそのタイトル・タイプ・バージョンを示します。フィルタータブの列で、タイプ、つまり PRDSpecDesignNoteReportOther で一覧を絞れます。これらのタイプに当てはまらないものは Other の下に現れます。New Document で手動で一つ追加します。

タイプフィルタータブと、タイプバッジとバージョンを示す文書カードのある文書一覧
文書一覧は、承認済み提案の文書とレポートを一緒に収めます。タイプで絞り込めます。

New Document を選び、タイトルとタイプを与え、任意で Markdown ファイル(.md.txt、または .markdown)を添えて内容の元にします。ファイルなしで作ると空の文書ができ、そのページから書き込めます。

文書を開くと、そのページで Markdown 本文を読めます。Edit を選んで内容を変え、Save Changes で保存します。保存のたびにバージョンが進みます。サイドバーは文書の詳細、その Source Proposal(設定されているとき、由来する提案へのリンク付き)、そして Version History を示します。内容の下のコメントで、それについて話し合えます。

文書とレポートがここにどう現れるか

Section titled “文書とレポートがここにどう現れるか”

文書は二つの道でこの一覧に届きます。

  • 承認済み提案から。 提案を承認すると、その文書の下書きはそれぞれ本物の Document に生成され、ここに現れます。承認が何を作るかは提案を審査をご覧ください。
  • 手動で。 上の New Document ダイアログです。

レポートReport タイプの文書です。他の文書と同じく Report フィルターの下に一覧に現れ、加えて完了レポートは着想ごとに集約されます。着想の 概要 はそのレポートを集め、その着想の成果を一か所で読めるようにします。

ユーザーまたはスーパー管理者は、破壊的な Delete ボタンで文書を消せます。削除は永久なので、確定する前に正しい文書であることを確かめてください。

文書はワークフローの成果物の一つです。それらが計画からどう生まれるかを見るには提案を審査を、それらが説明する仕事を追うには課題を実行を読んでください。完全な状態モデルは、ライフサイクル参考をご覧ください。