Википедия: Рефакторинг страниц обсуждения

Эта страница справки представляет собой практическое руководство . В нем подробно описаны процессы или процедуры некоторых аспектов норм и практики Википедии. Это не одна из политик или руководящих принципов Википедии и может отражать различные уровни консенсуса и проверки .

Ярлыки WP: RTP WP: РЕФАКТОР

Рефакторинг - это процесс редактирования, при котором содержимое страницы обсуждения перемещается, удаляется, редактируется, реструктурируется, скрывается или иным образом изменяется. Он применяется только в тех контекстах, где редакторы делают подписанные заявления (например, в пространствах имен Talk и User ).

Рефакторинг имеет ряд применений, в том числе:

• Повышение четкости и читабельности страницы
• Удаление не по теме, невежливости, неясности или иным образом отвлекающего материала
• Реструктуризация дискуссий для ясности
• Перемещение материала в другие разделы или страницы, где это более уместно

Рефакторинг более настойчив, чем редактирование копии, но менее существенен, чем архивирование . Подобно редактированию копии, он всегда сохраняет смысл и намерения исходного редактора. Как и архивирование, оно может скрыть материал от непосредственной видимости. Его следует использовать как инструмент для отделения ненужного материала от обсуждения на лету , не дожидаясь формального архивирования всего обсуждения.

Термин «рефакторинг» заимствован из рефакторинга кода в вычислениях , когда код реструктурируется (для улучшения его качества) таким образом, чтобы не изменять работу программы.

Хорошие практики рефакторинга - важная часть поддержания продуктивной страницы обсуждения. Запутанные, враждебные, чрезмерно сложные, плохо структурированные или перегруженные перекрестными обсуждениями страницы обсуждения могут отпугнуть потенциальных участников и вызвать недопонимание, которое подрывает плодотворные обсуждения.

Рефакторинг должен производиться только при условии добросовестности редакторов, которые внесли свой вклад в страницу обсуждения. Если на странице обсуждения в последнее время происходят жаркие дискуссии, возможно, недобросовестность отсутствует. Если другой редактор возражает против рефакторинга, изменения следует отменить. Тем не менее, если размер страницы превышает рекомендуемый размер, то можно выполнить архивирование страницы обсуждения или разделов без недавних публикаций без рефакторинга.

Обзор рефакторинга [ править ]

Ранее в истории Википедии, и особенно до 2006 года, содержание страницы обсуждения было обобщено для экономии места - это метод рефакторинга без консервантов. Однако сообщество предпочло оптовое архивирование обсуждений на страницах обсуждения, поскольку архивирование сохраняет более полную запись обсуждения, не приводит к искажению (случайному или нарушающему) мнению других редакторов и сохраняет материал, который может быть полезен в будущем. . Тот же принцип стал применяться к рефакторингу в более широком смысле.

Как правило, редакторы не должны редактировать комментарии друг друга таким образом, чтобы это влияло на смысл - это создает искажения, нарушает ход разговоров и делает невозможным наблюдение за дебатами и обсуждениями, - но бывают случаи, когда комментарии редактора должны быть удалены из поток разговора, потому что комментарии сами по себе нарушают течение разговора. В общих чертах, следующие типы рефакторинга являются допустимыми, с перечисленными оговорками:

Очистка без споров - все, в чем вы уверены, что другой редактор поблагодарит вас за усилия, а не рассердится.

• Добавление недостающих тематических заголовков и атрибуции
• Исправление уровней отступов
• Исправление мертвых ссылок
• Исправление технических вопросов, связанных с форматированием викитекста, таблицами, шаблонами, неработающими ссылками и т. Д.
• Улучшение заголовков с опечатками или заголовков, не описывающих содержание (используйте {{ привязку }} под новым заголовком, чтобы не разрывать ссылки на старый)
• Повторное прикрепление подписей, которые были отделены от текста, или добавление шаблонов «отсутствующих подписей», таких как {{ Unsigned2 }}, к комментариям, которые пользователи забыли подписать
• Другие мелкие исправления (исправление орфографии или грамматики других пользователей не рекомендуется, кроме как по техническим причинам, согласно предыдущему пункту)

Реструктуризация - следует проводить осторожно, чтобы не менять смыслы.

• Добавление новых разделов, разделяющих комментарий редактора на отдельные точки
• Перемещение комментария в более подходящее место в обсуждении
• Перемещение или копирование комментария, чтобы начать новое обсуждение в другом разделе

Обрезка текста - должна производиться только с согласия автора или при наличии уважительной причины в соответствии с политикой.

• Устранение, нанесение ударов или сокрытие личных нападок
• Скрытие лишних, устаревших или иным образом лишних материалов из поля зрения
• Перенос текста на разные страницы, где он более уместен

Как провести рефакторинг [ править ]

Следуя рекомендациям на странице обсуждения Википедии , редакторам рекомендуется удалять любой несоответствующий контент. Ссылка на историю страницы обсуждения должна быть добавлена, если удаленный текст был частью обсуждений других редакторов. См. WP: Diff для получения инструкций по созданию ссылки на историю страницы и WP: Рекомендации по страницам обсуждения # Поведение, которое недопустимо для указаний по несоответствующему содержанию страницы обсуждения.

Для рефакторинга материала доступно несколько инструментов и техник:

Удаление

Редактирование и удаление текста полностью. За исключением исправлений, не вызывающих разногласий, это должно выполняться только редактором, написавшим материал, либо сисопом или бюрократом с уважительной причиной. Если сисоп не использует Oversight , RevDel или страница не была полностью удалена, удаленный текст по-прежнему будет отображаться в старых версиях страницы.

Зачеркнутые

Использование зачеркнутых HTML-тегов - <s>text to be struck</s>создает текст, который нужно зачеркнуть . Этот текст по-прежнему плохо читается на странице и будет отображаться при поиске по страницам.

Перемещение текста за пределы страницы

Материал может быть изменен пользователем или перемещен на другую страницу, где это более уместно. Если позже рефакторинг будет отменен, перемещенный материал должен быть удален со страниц, на которые он был перемещен, чтобы предотвратить распространение текста.

Скрытые div, складные таблицы и шаблоны

Основная страница: Справка: Сворачивание

Ряд инструментов и шаблонов скрывают или блокируют текст от дальнейшего редактирования - {{ hidden }}, {{ cot }}, {{ hat }}, {{ archive top }}, {{ обсуждение top }}. Они работают за счет создания разборных элементов . Свернутый таким образом материал не отображается при поиске по страницам, если он не находится в развернутом состоянии. Используемый инструмент или техника следует выбирать в соответствии с конкретными потребностями материала.

Создание FAQ рекомендуется для любых вопросов, которые, вероятно, будут неоднократно подниматься и исправляться. Существующий материал следует соответствующим образом обобщить и переформатировать в простой формат вопроса / ответа, чтобы последующие редакторы могли решить свои проблемы, не поднимая вопрос снова. Аналогичным образом, длительные текущие обсуждения могут выиграть от рефакторинга шаблона с резюме. Шаблон {{ quote box }} можно использовать для создания плавающего окна сводки рядом с реорганизованным обсуждением, или комментарий может быть добавлен внизу (или иногда вверху) раздела.

Резекция [ править ]

В некоторых случаях обсуждение следует разбить на новые разделы или подразделы. Это полезно, когда раздел становится слишком длинным или когда разговор начинает расходиться на несколько отдельных моментов. Резекция может помочь как читателям, так и участникам понять ход обсуждения и помочь им найти соответствующие части текста.

При длительных обсуждениях участники часто вставляют произвольные перерывы, добавляя новый заголовок подраздела. Фактически, таким перерывам часто присваиваются заголовки вроде «Произвольный перерыв» или «Перерыв для удобства» с индексным номером, чтобы отличить его от других заголовков произвольного перерыва. Обсуждения, охватывающие несколько пунктов или усложняющиеся, напротив, могут выиграть от создания подразделов для рассмотрения различных вопросов или, в крайних случаях, путем разделения частей текста на совершенно новые разделы. В этих случаях может потребоваться реорганизация больших фрагментов текста, и в этом случае следует позаботиться о том, чтобы никакие комментарии не были вырваны из контекста или не потеряли связь с исходной точкой, к которой они обращались.Может быть целесообразно скопировать разделы текста, а не перемещать их (добавляя комментарий, который относится к исходному тексту), дублировать исходную подпись автора в разных точках, которые были перемещены в разные разделы, или начинать новый раздел с заявление в скобках, объясняющее исходный контекст комментария.

См. Примеры ниже.

Проблемы [ править ]

При рефакторинге следует учитывать следующие факторы:

• Рефакторинг может вызвать путаницу, если его неправильно применить к текущему обсуждению; Редактор должен позаботиться о том, чтобы все подобные обсуждения и все относящиеся к делу детали соответствовали контексту.
• Редакторы должны осознавать точку зрения новичка; не следует удалять контент, который принесет пользу редактору, который еще не читал страницу.

Имейте в виду, что не каждый редактор согласится с вашим рефакторингом или даже с концепцией рефакторинга в целом. Предоставьте ссылки на исходную неразрезанную версию, чтобы другие могли проверить ваши изменения и, при необходимости, вернуться к исходной версии, чтобы уточнить, что на самом деле сказал автор. Такое сочетание рефакторинга и архивирования часто позволяет избежать жалоб на потерю информации. Дайте понять, что вы что-то реорганизовали, чтобы никто не подумал, что это исходная страница обсуждения.

Если вы думаете, что люди могут возражать против рефакторинга их обсуждения, сделайте свое резюме на другой странице. Вместо того, чтобы сокращать архивы 7–10 Разговора: Новый Империализм , создайте новую страницу под названием [[Обсуждение: Новый Империализм / Сводка архивов 7–10]]. Свяжите это с верхней частью соответствующих архивов и с текущей страницей обсуждения. Это дает новичкам возможность быстро понять, не рискуя потерять то, что было раньше. Наличие связанного архива может помочь удовлетворить как тех, кто считает, что их слова должны оставаться нетронутыми, так и тех, кто хочет аккуратного резюме.

Расширенные инструменты [ править ]

Простой рефакторинг может быть легко выполнен с помощью стандартного редактирования браузера Википедии, но если вы столкнулись с особенно сложной или утомительной работой по рефакторингу, расширенный текстовый редактор или любой из ассортимента языков сценариев могут быть чрезвычайно полезны. По сути, любой инструмент с расширенными функциями поиска и замены, регулярное выражениевозможности или программная обработка текста станут вашим лучшим другом. Упорядочивание материала по алфавиту, сортировка разделов в хронологическом порядке, изменение нескольких ссылок, реструктуризация больших таблиц - эти задачи могут быть болезненными и трудоемкими, но их можно выполнить программно за считанные минуты. Большинство высококачественных текстовых редакторов офисного типа имеют расширенные возможности редактирования текста, и доступно множество легких, но мощных приложений для редактирования текста - см. Список текстовых редакторов . Также существует множество языков сценариев для обработки текста; распространенными из них являются Perl , Python , сценарии оболочки Unix и AppleScript .

Для длительных работ по рефакторингу может быть полезно пометить страницы, которые подвергаются рефакторингу, с помощью Template: In use . Просто добавьте {{in use}}вверху страниц. Это предупредит других редакторов о том, что страницы находятся в стадии разработки, и должно помочь минимизировать конфликты редактирования .

Важные примеры [ править ]

Страницы обсуждения или разделы страницы обсуждения, на которые был произведен рефакторинг:

• Внешний к чему? Ausdehnungslehre означает «теория расширений», а не «внешняя теория» (консервативный рефакторинг путем вставки заголовков абзацев).
• Есть ли соглашение о порядке мультивекторных компонентов? (консервативный рефакторинг путем вставки подзаголовков и заголовков абзацев)

См. Также [ править ]

• Википедия: Как заархивировать страницу обсуждения
• Википедия: Устранение личных атак
• Википедия: Обрезка исправлений статьи
• Википедия: Не такие уж и произвольные перерывы
• {{ Неприемлемый комментарий }}

Внешние ссылки [ править ]

• Рефакторинг вики-страниц
• Категория рефакторинга в Wiki
• Категория переделки на MeatBall