Help:Writing article introductions (Español)

From ArchWiki
Jump to navigation Jump to search
Estado de la traducción
Este artículo es una traducción de Help:Writing article introductions, revisada por última vez el 2019-09-15. Si advierte que la versión inglesa ha cambiado puede ayudar a actualizar la traducción, bien por usted mismo o bien avisando al equipo de traducción.

Este artículo fue escrito para ayudar a los escritores y editores de la wiki a crear artículos efectivos y ampliar la experiencia de los lectores de ArchWiki.

No es necesario que sepa cómo editar una página wiki para seguir este artículo. Esta página es una guía de estilo más general, en lugar de un Manual técnico para la edición.

Introducción del artículo

La introducción del artículo es (generalmente) lo primero que encuentran los lectores y tiene el propósito de presentarles al tema.

Cada artículo se inicia con un conjunto de presunciones. Estas presunciones rara vez son válidas para la mayoría de los lectores, y una introducción del artículo tiene el propósito de hacer de filtro para aquellos lectores que cumplen con las suposiciones de los escritores. Realmente no tiene que presentar a los lectores el resto del artículo, pero puede ayudar a aclarar algunas cosas, que de otra manera no lo serían, incluso después de leer todo el artículo... en muchos casos.

Por ejemplo, es posible que haya escrito un artículo sobre cómo configurar el sistema de cierta manera. Sin embargo, ha asumido que los lectores tienen un sisema Arch Linux limpio y recién instalado en su disco duro primario. ¿Cómo se vería afectado su método si el kernel estuviera, por ejemplo, personalizado? O, ¿cómo funcionaría el paso 3 si faltara el paquete X?

Debe pensar en los requisitos previos para su método y presentarlos antes de comenzar su artículo. Esto tiene dos beneficios claves:

  1. permite a los lectores decidir si quieren leer el artículo, antes de haber ido demasiado lejos;
  2. le permite escribir un artículo sin excesivas disertaciones innecesarias.

El número dos tiene un gran impacto en el aprovechamiento por parte del lector, y en realidad hace que su artículo sea más directo.

Hay una serie de cosas que podría considerar incluir en la introducción de su artículo, pero he aquí algunas de las más importantes sin ningún orden en particular:

  • experiencia previa y conocimientos necesarios;
  • estados del sistema y configuración;
  • propiedades de los componentes del hardware;
  • lo que los lectores no van a encontrar en el artículo.

El texto

Ya hemos mencionado algunas cosas que podría mencionar en una introducción del artículo. Ahora veremos algunos de los problemas que nos encontraremos al formular una introducción del artículo eficaz y útil.

Experiencias y conocimientos previos

Cuando se habla de experiencias previsas, debe tener en cuenta que el término experiencia tienen dos significados. Uno de ellos es más general. Podemos llamar a alguien novato o gurú basado en su conocimiento /experiencia/reputación general. El otro significado hace referencia a una experiencia concreta obtenida de participar en un evento o actividad (y el conocimiento derivado de ello). Por razones prácticas, es mejor exigir experiencia(s) previa(s) en el último sentido. La mayoría de los artículos en ArchWiki hablan sobre temas que son específicos y dentro de un determinado contexto. En un contexto dado, un novato puede mostrar competencia, mientras que un gurú puede mostrar falta de interés. Si necesita experiencias previas específicas, los lectores tienen una mejor oportunidad de juzgar su capacidad para seguir el resto del artículo.

También es posible que desee proporcionar a los lectores enlaces a recursos que los ayuden a obtener el conocimiento necesario para comprender el artículo.

Estados del sistema y configuración

A veces, un paquete ausente o un componente del sistema configurado de manera diferente puede hacer que un artículo sea inútil en algunos sistemas. Por lo tanto, debe seguir y definir toda la configuración relevante del sistema (como, parámetros rc.config relevantes, paquetes necesarios, etc.) siempre que sea posible.

Requisitos del hardware

Los requisitos de hardware suelen ser bastante obvios. Si está hablando de instalar controladores para el módem de acceso telefónico XYZ, nadie pensará que está hablando de un módem ZYX. Sin embargo, en algunos casos es bueno mencionar los requisitos específicos del hardware. Por ejemplo, si está escribiendo un artículo sobre la instalación de controladores para XYZ-123, puede advertir a los usuarios que es posible que la misma no se aplique a XYZ-456.

También es un buen toque agregar la foto del hardware que su artículo está a punto de discutir.

Lo que los lectores no van a encontrar en el artículo

En algunos casos, el título del artículo puede ser un poco engañoso. Por lo tanto, es posible que deba advertir a los lectores sobre el tema real del artículo, y posiblemente ofrecer un enlace a otros artículos que los lectores podrían haber estado buscando.

Por ejemplo, algunos lectores podrían haber pensado que este artículo era sobre cómo dar formato a las páginas usando el texto de wiki. Por lo tanto, a esos lectores se les advirtió que esta no es la página que estaban buscando, y se les proporcionó el enlace a la página correcta.

Formato

El formato de la introducción del artículo sigue el habitual propio de ArchWiki. Sin embargo, todavía hay algunos detalles que merecen una atención más cuidadosa.

Al enumerar los requisitos, tiene dos enfoques. Uno es explicar detalladamente los requisitos y otras notas introductorias para aclarar (su idioma aquí). El otro método es ofrecer una lista de requisitos bien organizada.