ウィキペディア:トークページのリファクタリング

ウィキペディアから、無料の百科事典
ナビゲーションにジャンプ 検索にジャンプ

リファクタリングは、トークページのコンテンツを移動、削除、改訂、再構築、非表示、またはその他の方法で変更する再製図プロセスです。これは、編集者が署名されたステートメントを作成するコンテキスト(TalkおよびUser talk名前空間など)にのみ適用されます。

リファクタリングには、次のような多くの用途があります。

  • ページの明瞭さと読みやすさの向上
  • トピックから外れた、非礼な、不明瞭な、またはその他の方法で気を散らす資料を削除する
  • 明確にするための議論の再構築
  • より適切な別のセクションまたはページに資料を再配置する

リファクタリングはコピー編集よりも積極的ですが、アーカイブよりも実質的ではありませんコピー編集と同様に、元の編集者の意味と意図を常に保持します。アーカイブのように、それは材料をすぐに見えないように隠すかもしれません。ディスカッション全体の正式なアーカイブを待たず に、その場でディスカッションから不要な資料を分離するためのツールとして使用する必要があります。

「リファクタリング」という用語は、プログラムの動作を変更しない方法でコードが(品質を向上させるために)再構築される 、コンピューティングにおけるコードリファクタリングから採用されています。

優れたリファクタリングの実践は、生産的なトークページを維持するための重要な部分です。混乱している、敵対的である、過度に複雑である、構造が不十分である、またはクロストークで混雑しているディスカッションページは、潜在的な寄稿者を落胆させ、実りあるディスカッションを損なう誤解を生む可能性があります。

リファクタリングは、トークページに寄稿した編集者が誠意を持って判断した場合にのみ実行する必要があります。トークページで最近白熱した議論がある場合は、誠実さが欠けている可能性があります。別のエディターが実行されたリファクタリングに反対する場合は、それらの変更を元に戻す必要があります。それでも、ページが推奨サイズよりも大きい場合は、リファクタリングなしでトークページまたはその中のセクションのアーカイブを行うことができます。

リファクタリングの概要

ウィキペディアの歴史の初期、特に2006年以前は、スペースを節約するためにトークページのコンテンツが要約されていました。これは非保存的なリファクタリング手法です。ただし、アーカイブはディスカッションの完全な記録を保持し、他の編集者の意見の不実表示(偶発的または混乱的)を引き起こさず、将来役立つ可能性のある資料を保存するため、コミュニティはトークページディスカッションの大規模なアーカイブを好むようになりました。 同じ原則が、より広くリファクタリングに適用されるようになりました。

原則として、編集者はお互いのコメントを意味に影響を与える方法で編集するべきではありません。編集すると、不実表示が生じ、会話の流れが妨げられ、討論や議論が不可能になりますが、編集者のコメントを削除する必要がある場合があります。コメント自体が会話の流れを混乱させるため、会話の流れ。大まかに言って、次のタイプのリファクタリングは正当ですが、リストされている警告があります。

論争のないクリーンアップ–他の編集者が怒るのではなく、努力に感謝すると確信しているものなら何でも。

  • 不足しているトピックの見出しと帰属を追加する
  • インデントレベルの修正
  • デッドリンクの修正
  • ウィキテキストのフォーマット、表、テンプレート、壊れたリンクなどの技術的な問題を修正する
  • タイプミスのある見出しや内容を説明していない見出しの改善(古い見出しへのリンクを壊さないように、新しい見出しの下にある{{ anchor }}を使用してください)
  • テキストから分割された署名を再添付するか、ユーザーが署名を忘れたコメントに{{ Unsigned2 }}などの「欠落している署名」テンプレートを追加します
  • その他のマイナーな修正(前のポイントによると、技術的な理由以外で、他のユーザーのスペルや文法を修正することはお勧めしません)

再構築–意味が変わらないように注意して行う必要があります。

  • 編集者のコメントを別々のポイントに分割する新しいセクションを追加する
  • コメントをディスカッションのより適切な場所に移動する
  • コメントを移動またはコピーして、別のセクションで新しいディスカッションを開始する

テキストの整理–元の作成者の同意がある場合、またはポリシーに基づいて正当な理由がある場合にのみ行う必要があります。

  • 個人攻撃の除去、攻撃、または非表示
  • 冗長な、古くなった、またはその他の方法で不要な素材を表示から隠す
  • より適切な別のページへのテキストの再配置

リファクタリングする方法

ウィキペディアのトークページのガイドラインに従って、編集者は適切でないコンテンツを削除することをお勧めします。削除されたテキストが他の編集者によるディスカッションの一部であった場合は、トークページの履歴へのリンクを追加する必要があります。ページ履歴へのリンクを作成するためのガイダンスについてはWP:Diffを、不適切なトークページのコンテンツに関するガイダンスとして は受け入れられないWP:Talkページのガイドライン#動作を参照してください。

マテリアルのリファクタリングに使用できるツールとテクニックはいくつかあります。

消す
テキストを完全に編集および削除します。論争のない修正を除いて、これは資料を書いた編集者、または正当な理由のあるシスオペまたは官僚によってのみ行われるべきです。シスオペがOversightRevDelを使用するか、ページが完全に削除されていない限り、削除されたテキストはページの古いリビジョンに引き続き表示されます。
三振
HTMLストライクアウトタグを使用–打たれるテキストを<s>text to be struck</s>生成しますこのテキストはまだページ上でわずかに読みやすく、ページ検索に表示されます。
テキストをページ外に移動する
資料は、ユーザーが使用したり、より適切な別のページに移動したりできます後でリファクタリングを元に戻す場合は、テキストの拡散を防ぐために、移動したページの移動した資料を削除する必要があります。
非表示のdiv、折りたたみ可能なテーブル、およびテンプレート

多くのツールとテンプレートは、テキストがそれ以上編集されないように非表示またはブロックします– {{ hidden }}、{{ cot }}、{{ hat }}、{{ archive top }}、{{ discussiontop }}。これらは、折りたたみ可能な要素を作成することによって機能しますこの方法で折りたたまれたマテリアルは、展開された状態でない限り、ページ検索に表示されません。使用するツールまたは技術は、材料の特定のニーズに応じて選択する必要があります。

繰り返し提起され、リファクタリングされる可能性のあるポイントについては、 FAQを作成することをお勧めします。既存の資料は適切に一般化され、単純な質問/回答形式に再フォーマットされて、後の編集者が再度質問を提起することなく懸念を満たせるようにする必要があります。同様に、長期にわたる継続的な議論は、要約を使用したテンプレートのリファクタリングから恩恵を受ける可能性があります。{{ quote box }}テンプレートを使用して、リファクタリングされたディスカッションの横にフローティングサマリーボックスを提供したり、セクションの下部(場合によっては上部)にコメントを追加したりできます。

切除

場合によっては、ディスカッションを新しいセクションまたはサブセクションに分割する必要があります。これは、セクションが長くなりすぎた場合、または会話がいくつかの別々のポイントに分岐し始めた場合に役立ちます。切除は、読者と参加者の両方が議論の流れを理解し、テキストの関連部分を見つけるのに役立つ可能性があります。

長い議論の場合、参加者は新しいサブセクションの見出しを追加して任意の休憩を挿入することがよくあります。実際、このような休憩には、「任意の休憩」や「便利な休憩」などの見出しが付けられ、他の任意の休憩の見出しと区別するためのインデックス番号が付けられていることがよくあります。対照的に、複数のポイントをカバーする、またはより複雑になるディスカッションは、異なるポイントに対処するためのサブセクションの作成から、または極端な場合にはテキストのセクションを完全に新しいセクションに分割することによって恩恵を受ける可能性があります。このような場合、テキストの大きな見本を再編成する必要がある場合があります。その場合は、コメントが文脈から外れたり、元のポイントとの接続が失われたりしないように注意する必要があります。

以下の例を参照してください

懸念

リファクタリングの際には、次の懸念事項を考慮する必要があります。

  • 進行中のディスカッションに不適切に適用された場合、リファクタリングは混乱を引き起こす可能性があります。編集者は、そのようなすべての議論とその文脈に関連するすべての詳細を保存するために細心の注意を払う必要があります。
  • 編集者は、新参者の視点を意識する必要があります。まだページを読んでいない編集者に役立つコンテンツを削除しないでください。

すべての編集者がリファクタリングや一般的なリファクタリングの概念に同意するわけではないことに注意してください。他の人があなたの変更を確認できるように、元のカットされていないバージョンへのリンクを提供し、必要に応じて元に戻って、作成者が実際に言ったことを明確にします。このリファクタリングとアーカイブの組み合わせにより、情報が失われたという苦情を防ぐことができます。何かをリファクタリングしたことを明示して、これが元のトークページであると誤解されないようにします。

ディスカッションがリファクタリングされることに反対する可能性があると思われる場合は、別のページに要約を作成してください。Talk:New Imperialismのアーカイブ7から10を減らすのではなく、[[Talk:New Imperialism / Summary of archives 7 to10]]というタイトルの新しいページを作成します。これを適切なアーカイブの上部と現在のトークページにリンクします。これにより、新規参入者は、以前に行ったことを失うリスクを冒すことなく、すばやく理解する機会が得られます。リンクされたアーカイブを持つことは、彼らの言葉が無傷のままでなければならないと感じている人々ときちんとした要約を望んでいる人々の両方を満足させるのに役立ちます。

高度なツール

単純なリファクタリングは、標準のWikipediaブラウザー編集で簡単に実行できますが、特に複雑または面倒なリファクタリング作業に直面している場合は、高度なテキストエディターまたはさまざまなスクリプト言語が非常に役立ちます。基本的に、検索および置換機能、正規表現を拡張したツール機能、またはプログラムによるテキスト処理があなたの親友になります。資料のアルファベット順、セクションの時系列への並べ替え、複数のリンクの変更、大きなテーブルの再構築–これらのタスクは手作業で行うのは面倒で時間がかかる場合がありますが、プログラムで数分で完了できます。ほとんどのハイエンドの「Office」タイプのテキストエディタには高度なテキスト編集機能があり、軽量で強力なテキスト編集アプリケーションが多数利用できます。テキストエディタのリストを参照してください。テキスト処理用の多くのスクリプト言語も存在します。一般的なものは、 PerlPythonUnixシェルスクリプト、およびAppleScriptです。

長いリファクタリングジョブの場合、リファクタリング中のページにTemplate:Inuseでタグを付けると役立つ場合があります{{in use}}ページの上部に追加するだけです。これにより、ページが作成中であるという事実を他の編集者に警告し、編集の競合を最小限に抑えるのに役立つはずです。

重要な例

リファクタリングの恩恵を受けたトークページまたはトークページセクション:

も参照してください

外部リンク