La refactorización es un proceso de nueva redacción en el que el contenido de la página de discusión se mueve, elimina, revisa, reestructura, oculta o cambia de otro modo. Se aplica solo en contextos en los que los editores realizan declaraciones firmadas (como en los espacios de nombres de Talk y User ).
La refactorización tiene varios usos, que incluyen:
- Mejorar la claridad y la legibilidad de una página.
- Eliminar material fuera del tema, descortés, poco claro o que distraiga de alguna manera
- Reestructuración de discusiones para mayor claridad.
- Reubicar material a diferentes secciones o páginas donde sea más apropiado
La refactorización es más asertiva que la edición de textos, pero menos sustantiva que el archivo . Al igual que la edición de textos, siempre conserva el significado y la intención del editor original. Al igual que el archivo, puede ocultar el material de la visibilidad inmediata. Debe utilizarse como una herramienta para separar el material innecesario de una discusión sobre la marcha , sin esperar al archivo formal de toda la discusión.
El término "refactorización" es una adaptación de la refactorización de código en informática , donde el código se reestructura (para mejorar su calidad) de una manera que no cambia el funcionamiento del programa.
Las buenas prácticas de refactorización son una parte importante para mantener una página de conversación productiva. Las páginas de discusión que son confusas, hostiles, demasiado complejas, mal estructuradas o congestionadas con conversaciones cruzadas pueden desalentar a los contribuyentes potenciales y crear malentendidos que socavan las discusiones fructíferas.
La refactorización solo debe realizarse cuando existe una suposición de buena fe por parte de los editores que han contribuido a la página de discusión. Si hay discusiones acaloradas recientes en la página de discusión, es posible que falte buena fe. Si otro editor se opone a la refactorización, los cambios deben revertirse. Sin embargo, si la página es más grande que el tamaño recomendado, entonces aún se puede archivar la página de discusión, o las secciones sin contribuciones recientes, sin refactorizar.
Descripción general de la refactorización
Anteriormente en la historia de Wikipedia, y particularmente antes de 2006, el contenido de la página de discusión se resumió para ahorrar espacio, un método de refactorización no conservante. Sin embargo, la comunidad ha llegado a preferir el archivo al por mayor de las discusiones de las páginas de discusión, ya que el archivo conserva un registro más completo de la discusión, no conduce a una tergiversación (accidental o disruptiva) de las opiniones de otros editores y conserva material que puede ser útil en el futuro. . El mismo principio se ha aplicado a la refactorización de manera más amplia.
Como regla general, los editores no deben editar los comentarios de los demás de manera que afecten el significado; hacerlo crea tergiversaciones, interrumpe el flujo de conversaciones y hace que los debates y las discusiones sean imposibles de seguir, pero existen casos en los que los comentarios de un editor deben eliminarse de el flujo de la conversación porque los comentarios mismos interrumpen el flujo de la conversación. En términos generales, los siguientes tipos de refactorización son legítimos, con las advertencias enumeradas:
Limpieza no contenciosa : cualquier cosa en la que esté seguro de que el otro editor le agradecerá el esfuerzo, en lugar de enojarse.
- Adición de atribuciones y encabezados de temas que faltan
- Corrección de niveles de sangría
- Arreglando enlaces muertos
- Solucionar problemas técnicos de formato de wikitexto, tablas, plantillas, enlaces rotos y similares.
- Mejorar títulos con errores tipográficos o que no sean descriptivos del contenido (use {{ ancla }} debajo del nuevo título para no romper ningún enlace al anterior)
- Volver a adjuntar firmas que se han separado del texto o agregar plantillas de "firma faltante" como {{ Unsigned2 }} a los comentarios que los usuarios han olvidado firmar.
- Otras correcciones menores (se desaconseja corregir la ortografía o la gramática de otros usuarios, salvo por razones técnicas, según el punto anterior)
Reestructuración : debe hacerse con cuidado para evitar cambiar los significados.
- Agregar nuevas secciones que dividen el comentario de un editor en puntos separados
- Mover un comentario a un lugar más apropiado en la discusión
- Mover o copiar un comentario para comenzar una nueva discusión en una sección diferente
Texto de poda : solo debe hacerse con el consentimiento del autor original o con una buena causa según la política.
- Eliminar, golpear u ocultar ataques personales
- Ocultar material redundante, desactualizado o superfluo de cualquier otro modo de la vista
- Reubicación de texto a diferentes páginas donde sea más apropiado
Cómo refactorizar
Siguiendo las pautas de la página de discusión de Wikipedia , se alienta a los editores a eliminar cualquier contenido que no sea apropiado. Se debe agregar un enlace al historial de la página de discusión si el texto eliminado fue parte de las discusiones de otros editores. Consulte WP: Diff para obtener orientación sobre cómo crear un enlace al historial de la página y las pautas de la página WP: Talk # Comportamiento que es inaceptable para obtener orientación sobre el contenido inapropiado de la página de discusión.
Hay varias herramientas y técnicas disponibles para refactorizar material:
- Supresión
- Editando y borrando el texto por completo. A excepción de las correcciones no contenciosas, esto solo debe ser realizado por el editor que escribió el material o por un sysop o burócrata con causa legítima. A menos que un operador de sistema use Oversight , RevDel o una página se haya eliminado por completo, el texto eliminado seguirá apareciendo en las revisiones anteriores de la página.
- Tachados
- El uso de etiquetas HTML tachadas:
producetext to be strucktexto para tachar. Este texto todavía se puede leer marginalmente en la página y aparecerá en las búsquedas de la página. - Mover texto fuera de la página
- El material se puede usar o mover a una página diferente donde sea más apropiado. Si la refactorización se revierte posteriormente, el material movido debe eliminarse en las páginas a las que se movió, para evitar la proliferación del texto.
- Divs ocultos, tablas plegables y plantillas
Varias herramientas y plantillas ocultan o bloquean el texto para que no se siga editando: {{ hidden }}, {{ cot }}, {{ hat }}, {{ archive top }}, {{ discusion top }}. Estos funcionan creando elementos plegables . El material contraído de esta manera no aparece en las búsquedas de páginas a menos que esté en un estado expandido. La herramienta o técnica utilizada debe elegirse de acuerdo con las necesidades particulares del material.
Se recomienda la creación de una FAQ para cualquier punto que sea probable que se plantee y refactorice repetidamente. El material existente debe generalizarse de manera adecuada y reformatearse en un formato de pregunta / respuesta simple para que los editores posteriores puedan satisfacer sus inquietudes sin volver a plantear la pregunta. Del mismo modo, las discusiones prolongadas en curso podrían beneficiarse de la refactorización de la plantilla con un resumen. La plantilla {{ quote box }} se puede usar para proporcionar un cuadro de resumen flotante junto a una discusión refactorizada, o se puede agregar un comentario en la parte inferior (o, a veces, en la parte superior) de una sección.
Resección
En algunos casos, la discusión debe dividirse en nuevas secciones o subsecciones. Esto es útil cuando una sección se vuelve demasiado larga o cuando la conversación comienza a divergir en varios puntos separados. La resección puede ayudar tanto a los lectores como a los participantes a comprender el flujo de la discusión y ayudarlos a encontrar partes relevantes del texto.
Para discusiones largas, los participantes a menudo insertan pausas arbitrarias agregando un nuevo encabezado de subsección. De hecho, estas rupturas a menudo reciben títulos como "ruptura arbitraria" o "ruptura de conveniencia", con un número de índice para distinguirlo de otros encabezados de ruptura arbitraria. Las discusiones que cubren múltiples puntos o se vuelven más complejas, por el contrario, pueden beneficiarse de la creación de subsecciones para abordar diferentes puntos o, en casos extremos, dividiendo secciones de texto en secciones completamente nuevas. En estos casos, puede ser necesario reorganizar grandes fragmentos de texto y, de ser así, se debe tener cuidado para asegurarse de que ningún comentario se saque de contexto o pierda la conexión con el punto original al que se referían. Puede ser aconsejable copiar secciones de texto en lugar de moverlas (agregando un comentario que se refiera al texto original), duplicar la firma del autor original en diferentes puntos que se han movido a diferentes secciones o comenzar la nueva sección con una declaración entre paréntesis que explica el contexto original del comentario.
Vea los ejemplos a continuación.
Preocupaciones
Estas preocupaciones deben tenerse en cuenta al refactorizar:
- La refactorización puede causar confusión si se aplica incorrectamente a una discusión en curso; un editor debe tener mucho cuidado de preservar toda esa discusión y todos los detalles relevantes para su contexto.
- Los editores deben ser conscientes de la perspectiva del recién llegado; no se debe eliminar contenido que pueda beneficiar a un editor que aún no haya leído la página.
Tenga en cuenta que no todos los editores estarán de acuerdo con su refactorización o incluso con el concepto de refactorización en general. Proporcione enlaces a la versión original, sin cortes, para que otros puedan verificar sus cambios y, si es necesario, volver al original para aclarar lo que realmente dijo un autor. Esta combinación de refactorización y archivo evitará a menudo quejas de pérdida de información. Deje explícito que ha refactorizado algo para que nadie se engañe y piense que esta era la página de discusión original.
Si cree que la gente puede oponerse a que se refactorice su discusión, haga su resumen en una página diferente. En lugar de reducir los archivos 7 a 10 de Charla: Nuevo Imperialismo , cree una nueva página titulada [[Charla: Nuevo Imperialismo / Resumen de los archivos 7 a 10]]. Enlaza esto a la parte superior de los archivos correspondientes y a la página de discusión actual. Esto les da a los recién llegados la oportunidad de obtener una comprensión rápida sin el riesgo de perder lo que ha sucedido antes. Tener un archivo vinculado puede ayudar a satisfacer tanto a quienes sienten que sus palabras deben permanecer intactas como a quienes desean un resumen ordenado.
Herramientas avanzadas
La refactorización simple se puede hacer fácilmente con la edición estándar del navegador Wikipedia, pero si se enfrenta a un trabajo de refactorización particularmente complejo o tedioso, un editor de texto avanzado o cualquiera de una variedad de lenguajes de scripting puede ser de gran ayuda. Básicamente, cualquier herramienta que tenga funciones extendidas de búsqueda y reemplazo, capacidades de expresión regular o procesamiento de texto programático se convertirá en su mejor amigo. Alfabetizar el material, clasificar las secciones en orden cronológico, cambiar varios enlaces, reestructurar tablas grandes: estas tareas pueden ser dolorosas y llevar mucho tiempo hacerlas a mano, pero se pueden realizar en cuestión de minutos mediante programación. La mayoría de los editores de texto de tipo "Office" de gama alta tienen capacidades avanzadas de edición de texto, y hay disponibles muchas aplicaciones de edición de texto ligeras pero potentes; consulte la lista de editores de texto . También existen muchos lenguajes de secuencias de comandos para el procesamiento de texto; los más comunes son Perl , Python , secuencias de comandos de shell de Unix y AppleScript .
Para trabajos de refactorización largos, puede ser útil etiquetar las páginas que se están refactorizando con Plantilla: en uso . Simplemente agregue {{in use}}
en la parte superior de la (s) página (s). Esto alertará a otros editores sobre el hecho de que las páginas están en construcción y debería ayudar a minimizar los conflictos de edición .
Ejemplos significativos
Páginas de discusión o secciones de la página de discusión que se han beneficiado de la refactorización:
- ¿Exterior a qué? Ausdehnungslehre significa "teoría de la extensión", no "teoría exterior" (refactorización conservadora insertando títulos de párrafos)
- ¿Existe una convención sobre el orden de los componentes multivectoriales? (refactorización conservadora insertando subtítulos y títulos de párrafo)
Ver también
- Wikipedia: cómo archivar una página de discusión
- Wikipedia: eliminar ataques personales
- Wikipedia: revisión de artículos de poda
- Wikipedia: rupturas no tan arbitrarias
- {{ Comentario inapropiado }}