最近、meta のドキュメントを改善する取り組みを行っており、さまざまなユーザーが関連するトピックを見つけ、関連しないトピックを無視できるように分類することに重点を置いています。
すべてのドキュメントは、次のいずれかのカテゴリに分類されることを目指しています。
- #documentation:users - 一般的な一般的な使用法
- #documentation:moderators - コミュニティのモデレーション
- #documentation:theme-developers - テーマやテーマコンポーネントの開発
- #documentation:admins - Discourse サイトの管理
- #documentation:devs - Discourse の機能、プラグイン、統合の開発
- #documentation:sysadmin - セルフホスト型システム管理
#documentation:faq と #documentation:tips-and-tricks は、この (ただし、一部のトピックは新しいカテゴリに #tips-and-tricks としてタグ付けされ始めています) の終わりに削除する予定です。
また、divio から借用した次のいずれかの分類タグでドキュメントにタグ付けすることを目指しています。このタグは、この以前の投稿 に基づいています。
物事は常に完璧に収まるわけではありません。場合によってはトピックを分割し、場合によっては現在の状態に最も適したタグまたはカテゴリを使用しています。
これまでに個々のトピックに対して行ってきた一般的な変更の一部 (現在約 50% 完了) です。
- コンソールアクセスが必要な場合は、#documentation:admins から #documentation:sysadmin に移動します。
- #documentation:faq のトピックを #documentation:admins 用のトピックと #documentation:users 用のトピックに分割します。
- テーマまたはテーマコンポーネントの開発に特化した場合は、#documentation:devs から #documentation:theme-developers にトピックを移動します。
- トピックのタイトルをより一貫性のあるものに更新します。
- トピックのタイトルには命令形を使用します (タイトルから「方法」を削除します)。
- 通常の文の大文字小文字を使用します。
- H2 から始まる見出しでコンテンツをフォーマットします。
(関連: すべてのドキュメント トピックで目次を有効にしました)
場合によっては、コンテンツ自体に変更を加えますが、深く掘り下げることは当面の目標ではありません。将来のパスでは、次のようなことを行いたいと考えています。
- 回答からのコンテンツをドキュメントに組み込む
- すべての回答を削除する
- 1〜2か月後に回答を削除するようにトピックを構成する
その後、新しいドキュメントの作成と既存のドキュメントの維持に関する更新されたガイダンスを提供し、次のトピックを更新します。
たとえば、より多くのドキュメントを Wiki にしたり、元の投稿者以外の人が維持しているドキュメントの新しい所有者を見つけたりしたい場合があります。
また、#documentation:tips-and-tricks の一部であったコンテンツのラインに沿って、「ショー＆テル」をさらに行うための別のスペースを作成する機会があると考えています。ドキュメントの外にこのようなトピックのためのスペースを設けることで、同僚の間でそれらについて議論するためのより多くの余地ができるかもしれません。しかし、現在ドキュメントで行っていることと同様に、おそらくシステム管理者、管理者、および開発者ごとに、それらの議論のための別のスペースを持つことが役立つでしょう。どう思いますか？