改善案
読み手がパックへの改善を提案し、所有者が解決する仕組みです。
改善案は、ワークフロー / コンテキスト・パックに対するテキスト中心の提案です。パックを読める人なら誰でも変更を提案でき、パックの所有者がそれをレビューして解決します。改善案はパックを直接編集しません。提案内容は改善案のテキストとして残り、所有者が通常のパック更新で反映します。
改善案はパックの内容とは分離されています。書き込み権限がなくても協力者やコミュニティのメンバーがパックを改善でき、実際に何を変えるかは所有者がコントロールしたままになります。
ライフサイクル
改善案には必ず status があります。
| ステータス | 意味 | 設定する人 |
|---|---|---|
open |
提出済みで、所有者の判断待ち(初期状態)。 | 投稿者(作成時) |
applied |
所有者が受け入れ、変更が反映された。 | 所有者(解決時) |
declined |
所有者が対応しないと判断した。 | 所有者(解決時) |
archived |
判断せず脇に置き、受信箱を整理する。 | 所有者(解決時) |
改善案は open で始まります。所有者が applied、declined、archived に移し、open に戻すこともできます。改善案の解決はステータスを変えるだけで、実際のパック編集は別途のパック更新です。
スナップショット
改善案が作成されると、その時点のパックの内容が不変の スナップショット として保存されます。あとでパックが変わっても、改善案は投稿者が実際に見た内容に紐づいたままになります。読み取り API はデフォルトでスナップショットを省略します。現在のパックと比較したいときに明示的に取得してください。
一覧と取得
一覧は各改善案の content を短縮プレビューで返します。パックと同じ selective-fetch(まずアウトライン、全文は必要時)の考え方です。全文は1件取得で読みます。web では一覧から詳細ページにリンクし、そこで全文を読み込みます。
権限
| 操作 | 実行できる人 |
|---|---|
| 作成 | パックを読めるすべての人(private / public)。 |
| 更新(タイトル / 本文) | 投稿者のみ。 |
| 解決(ステータス変更) | パックの所有者のみ。 |
| 取得 / 一覧 | その改善案を読める権限を持つ人。 |
改善案の作成は 5 credits、一覧は 2 credits、取得・更新・解決は 1 credit です。さらに1アカウントあたり 1日20件まで 作成できます。
使いどころ
- 自分が所有していない公開パックに、修正や追加を提案する。
- 共有ワークフローを自分で編集せずに、チームメイトへフィードバックする。
- 自分が運用するパックへの改善案を1つの受信箱に集め、良いものを反映する。
変更を提案したいときは改善案を、自分が所有するパックを変更するときはパック更新を使います。