Open7

スクラップ機能 ある/なし

ある / なし

Zennのスクラップはシナリオ執筆や絵コンテ整理用に個人的に内製したWikiによく似ている気がしている。そっちは大分老朽化していて作りなおしたいので、UI要素を考察したい。

プログラミングのトピックにもこのデザインは有用で、あんまり面白くない作業を1週間がまんできた。。

https://zenn.dev/okuoku/scraps/a0a74834db15e6

デザイン

スクラップのUIは、(スクラップ全体を文書として捉えたときに、)文書の大部分がフォーマットされた状態で編集することができる。

これはZennやQiitaの通常記事のような、 記事全体の未フォーマット状態を見ながら編集するUI と、ScrapboxのようなWYSIWYGエディタの 折衷 であり、個人的には良い落しどころだと思う。

(Qiitaの2ペインは画像が多い場合に追従の信頼性が低く、Zennのような完全分離とUX的にあまり変わらない)

DITAフレンドリ

コメント粒度の編集はDITAで推奨されるスタイルでもある。

https://dita-jp.org/webhelp-feedback/#about_dita/from_book_to_map.html

トピック指向のマニュアルでは、各トピックが「~とは?」、「~するにはどうすればよいのか?」、「何がおかしいのか?」といった問いに対する答えを提供します。各トピックは、1つの主題について合目的的かつ簡潔明瞭に書かれ、余計な情報を含まないため、読者は素早くトピックに含まれる情報を理解できます。

(ただしマップに相当する機能性はスクラップには無い -- コメントの寄せ集め再編集で記事を作る 的な機能が必要になる)

ある: Open/Close/アーカイブ

スクラップはGitHubのissuesのようなOpen/Close状態がある。 ... GitHubのissueは一目で結論がわからない(= 表題が実現されたのかどうかが不明なので表題の価値が低い)ので評判はあまりよくない。

スクラップには、さらに"アーカイブ" -- 要するにゴミ箱がある。

必要性は正直よくわからない。もっともJIRAとかでバカみてぇに大量のissueステートを運用しているチームも居るくらいなので、非常に単純化された状態遷移というのに狙いがあるのかもしれない。

ある: リンクのカード化

これ便利。採用 ■。

カード化したくない場合は適当な文字を同じ行に入れれば良い。編集UIを付けたりするよりは有利かな。

ただ、GitHubのリンクを貼ったらソースコードのSnippetにするみたいな機能は欲しい。。そういう変更を後方互換を保ちながら入れるのも難しくどうしたもんか。。この手の自動編集機能もバージョン管理して手動アップグレード可能にする。。?

ない: キーワード / キー文字 機能

関係キー

prev: や next: のような関係キーによってスレッド間にセマンティックなリンクを貼れない。スクラップ表題の Meta: (DITAで言うマップ) やdiary: のようなトピックキーワードが書けない。

↓ Meta: には常にprev: next:のキーワードを入れ、その週に起票した全スクラップもリンクしている。

https://zenn.dev/okuoku/scraps/c236209827218e

推敲マーカー

■(rationale) や ★(ToDo) のような文字マーカーでカードの抽出を行えない。インラインバグトラッカができない。

ない: 段落へのリンク / 編集履歴

リンクの最小単位はコメントであり、コメント内の文書の段落にはリンクやコメントができない。現状のスクラップの用法ではあまり必要性がない。推敲ツールとしては必須だけど。。

また、Qiita等と異なりZennは全体的に編集履歴機能がない。まぁ必要ならGitリポジトリでやれば良いし。。

ない: 表題とアウトライン

何気にこれが最大の違いだな。。スクラップは個々のコメントがフラットで、表題の設定を要求しない。

まぁ実際に日時だけみたいな表題を設定しがちだったから、無いほうが良いのかも。ファイル名というかリンク名はハッシュになる。

ログインするとコメントできます