コンテンツのセクションを掲載終了する方法
この記事では、MDN Web Docs のコンテンツの特定のセクション全体を掲載終了するプロセス、いわゆる掲載終了について説明します。掲載終了は、個々のページの削除や移動とは異なります。これは、セクション全体がもはや積極的に保守されていなかったり、関連性がなくなったり、MDN の目標に沿わなくなったりした場合に適用され、計画的かつ透明性のある方法で掲載終了する必要があります。掲載終了したコンテンツは完全に削除されるわけではなく、常に MDN Museum リポジトリーにアーカイブされます。
セクションの掲載終了はとても稀なケースであり、その手順は状況によって異なります。このガイドでは、セクションをいつ、どのように掲載終了すべきか、また責任を持って掲載終了を行うための手順について概要を説明します。すでに掲載終了したセクションの一覧については、掲載終了したコンテンツをご覧ください。
このガイドにおいて、セクションとは、MDN Web Docs 内の独立した領域を指します。通常は、トップレベルのフォルダー内(例えば /Web/SECTION_NAME)または一貫性のあるサブツリー(例えば /Learn_web_development/PATH/SECTION_NAME)であり、技術リファレンス全体や学習コース全体などが該当します。このプロセスは、以下のものには適用されません。
- 標準的な非推奨化プロセスに従い、他の機能は引き続き有効な領域において、個々のウェブプラットフォーム機能を非推奨の機能としてマークすること。
- 単一のページやガイドを削除する手順については、ページの削除のガイドに掲載されています。
削除するものが掲載終了に該当するかどうか判断に迷う場合は、手続きが始まる前に、GitHub のディスカッションでその点を提起してください。
コンテンツの削除を検討すべきタイミング
以下のいずれかに該当する場合は、MDN Web Docs のコンテンツの一部を掲載終了することを提案することがあります。
- この技術が非推奨となっているか、ウェブプラットフォームにおいてもはや関連がない。
- このセクションには、他の場所(フレームワークの公式ドキュメントサイトなど)でより適切に管理されている情報が重複して記載されている。
- このセクションは、MDN のコンテンツ戦略に沿っていない。
- メンテナンスコストがユーザーへの価値を上回っていることが、利用データやユーザーからのフィードバックから判明した。
セクションの掲載終了は、常に慎重かつ透明性のあるプロセスで行われるべきです。大規模な削除は、ディスカッションや事前通知なしに行われてはなりません。セクションを掲載終了する最終決定権は、MDN チームにあります。
メモ: セクション全体ではなく、個々のページを除去したい場合は、ページの削除のガイドを参照してください。個々の機能を「非推奨」としてラベル付けする方法については、技術のラベル付け方法を参照してください。
掲載終了プロセス
MDN Web Docs のコンテンツの一部を掲載終了するには、合意形成とコンテンツの削除という 2 つのフェーズがあります。
フェーズ 1: 意思決定プロセス
掲載終了については、MDN チームおよびパートナーの合意が必要です。話し合いは、当コミュニティのコミュニケーションチャネル、GitHub のディスカッション、編集会議(2 週間ごとに開催)で行われます。
あるセクションの掲載終了が真剣に検討されている場合は、その決定とプロセスを捕捉するために、GitHub 上でディスカッションを開く必要があります。そのディスカッションでは、以下の点を明確にすべきです。
- 削除の理由。
- 削除の影響。
- 関係するステークホルダーにはその旨が周知されており、協議も行われていること。
- 検討した他のアプローチ。
場合によっては、その決定に MDN ユーザーからのフィードバックの収集が含まれることもあります。これには、次のようなものがあります。
- ユーザーアンケートを実行する。
- GitHub やそれ以外にも MDN のコミュニケーションチャンネルを通じてフィードバックを依頼する。
その目的は、当該セクションがもはやユーザーのニーズを満たしておらず、その持続的な維持管理に向けた明確な道筋が存在しなくなったことを確認することです。
セクションを掲載終了することで合意に達した場合は、スケジュールを設定する必要があります。通常、その期間は 3 ~ 6 か月程度です。その理由とスケジュールは、GitHub のディスカッションに記録しておく必要があります。また、ディスカッションでは、そのコンテンツが完全に削除されるのではなく、アーカイブされるものであることが明確に示される必要があります。
掲載終了しないという決定が達された場合は、その旨と理由を、元々の連絡手段を通じて伝える必要があります。
フェーズ 2: コンテンツの削除
合意が成立したら、以下の手順に従ってコンテンツを削除してください。
掲載終了のお知らせバナーを追加する
掲載終了されるセクション内にある_すべての記事_の先頭に、お知らせバナーを追加してください。バナーには、以下の内容を明確に明記してください。
- 当該セクションがウェブサイトから削除されること。
- 削除の予定時期および日程。
- コンテンツがアーカイブされること。
- 詳細については GitHub のディスカッションへのリンク。
以下のテンプレートを使用してください。
> [!NOTE]
> MDN のこのセクションは保守が終了しており、6 か月後(年と月で)にウェブサイトから削除される予定です。コンテンツは [MDN Museum](https://github.com/mdn/museum) にアーカイブされます。詳しい情報については、[こちらのディスカッション](リンク)をご覧ください。
この通知は透明性を確保し、ユーザーが調整するための時間を確保するものです。
コンテンツのアーカイブと削除
合意された公開期間が経過した後、MDN Web Docs からコンテンツを次のように削除できます。
-
コンテンツをアーカイブしてください。 アーカイブのため、そのセクションを MDN Museum リポジトリーにコピーしてください。コンテンツは、元の URL パスと一致するディレクトリーに保存してください。例えば、
https://developer.mozilla.org/en-US/docs/Gamesにあるコンテンツは、museum リポジトリー内の/docs/games/ディレクトリーに配置します。これにより、MDN のコンテンツ履歴を保持しつつ、非推奨のコンテンツをアクティブなサイトから削除することができます。 -
コンテンツを削除し、リダイレクトを追加してください。
deleteコマンドを使用してページを削除し、リダイレクトを追加してください。リダイレクトは、利用できる代替コンテンツが存在する場合は、ユーザーを最も関連性の高い代替コンテンツへ誘導するように設定してください。適切な代替コンテンツがない場合は、掲載終了したコンテンツの一覧ページにある対応する項目へリダイレクトしてください(セクション固有のアンカー、例:#section_nameを使用)。これにより、読者は削除された内容に関するコンテキストを確認し、リンクをたどってアーカイブ版にアクセスできるようになります。MDN Web Docs のトップページへのリダイレクトは避けることができます。そうすると、読者に説明が提供されなくなってしまいます。 -
参照先を整理してください。 サイドバーの定義、ランディングページ、他の記事からの相互リンクなど、MDN 全体にわたって掲載終了したセクションへの参照を、すべて削除または更新してください。リダイレクトを追加すれば(ステップ 2 を参照)、リンク切れを防ぐことはできますが、参照元のコンテンツを直接更新することが最善の手法です。
-
UI の更新について、issue を登録してください。 ウェブサイトの UI の一部(ナビゲーションメニューやホームページのセクションなど)は、
contentリポジトリーに属しておらず、プラットフォームチームによって管理されています。mdn/fred リポジトリーに課題を登録し、掲載終了したコンテンツへの参照を除去するために UI の変更が必要かどうかを調べてください。変更が必要であれば、コンテンツの除去と UI の更新を調整し、同時に展開されるようにしてください。
警告: コンテンツを先にアーカイブせずに、完全に削除しないでください。