User Tools
wiki:practicas
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
wiki:practicas [13/11/2016 19:21] admin |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== Consejos para un buen estilo ====== | ||
| - | //Tomado de https://www.dokuwiki.org/es:tips:good_style // | ||
| - | Estos son unos cuantos consejos para escribir correctamente una página wiki. | ||
| - | |||
| - | ===== Estructura de página ===== | ||
| - | * Empieza la página con un encabezado de primer nivel que sea significativo. | ||
| - | * Anida los encabezados en el orden correcto, las secciones de segundo nivel deben comenzar con un encabezado de segundo nivel. | ||
| - | * Organiza el texto en párrafos dejando una línea vacía entre ellos. El párrafo medio no debe superar las 10-20 líneas. | ||
| - | * Si el texto es mayor de unos cuantos párrafos (3-5), considera el dividirlo en [[wiki:syntax#secciones|secciones]] añadiendo encabezados de menor nivel (de segundo a quinto nivel). | ||
| - | * Si el texto es muy largo (de 2-3 pantallas de scroll), pon un pequeño resumen de los contenidos de la página después del primer encabezado. Si la página se alarga en exceso considera el dividirla en varias páginas. | ||
| - | * Si hay muchos enlaces a otras páginas o a recursos externos, añade una sección especial con más referencias (ver [[#referencias|más abajo]]). | ||
| - | * Si muchas de las páginas de un [[dokues>namespaces|namespace]] comparten una estructura común añade una [[dokues>namespace_templates|plantilla de namespace]] de tal manera que cada nueva página tenga esa estructura de partida. | ||
| - | * Evita estructuras de namespaces muy complicadas. Usa nombres de namespace cortos y fáciles de recordar. | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | ===== Formato de texto ===== | ||
| - | * Enfatiza palabras o pasajes cortos del texto usando **negrita** o //cursiva//. Elige una de ellas y úsala de forma consistente. | ||
| - | * Elige un estilo para la presentación en pantalla y texto como botones o etiquetas de menú y úsalo de forma consistente. Es buena idea añadir una página con explicaciones sobre las convenciones de estilo del wiki. | ||
| - | * Usa [[dokues>wiki:syntax#listas|listas sin numerar]] para sentencias que son independientes unas de otras. Si estás desarrollando una línea de pensamiento, utiliza una secuencia contínua de sentencias. | ||
| - | * Usa [[dokues>wiki:syntax#notas_al_pie|notas al pie]] con moderación y sólo para resaltar temas adicionales de forma breve. Si hay mucho que explicar acerca de un tema ponlo en una nueva página. Si quieres hacer referencia a otras fuentes (externas) de información, usa los [[dokues>wiki:syntax#enlaces|enlaces]] en su lugar. | ||
| - | * Las tablas pueden mejorar significativamente la legibilidad de datos estructurados. Si insertas una tabla, asegúrate de que las celdas de cabecera son entendibles y que tiene un título que describa claramente los contenidos de la tabla (por ejemplo: "Tabla 1.2: Distancias medias entre planetas"). | ||
| - | * Las tablas muy grandes son difíciles de editar. En su lugar, evalua la posibilidad de representar los datos mediante listas anidadas. | ||
| - | |||
| - | ===== Lenguaje ===== | ||
| - | * Escribe las frases correctamente y usa artículos para los nombres cuando sea necesario. | ||
| - | * Comienza cada frase con mayúscula y termínala con punto y aparte o cualquier signo de puntuación apropiado. | ||
| - | * Intenta escribir frases breves y claras sin abusar de las subordinadas. Cuando creas que has terminado la página, léela de nuevo y revisa cualquier frase que tenga una estructura complicada. | ||
| - | * Decide cómo dirigirte a los lectores. DokuWiki está orientado a escribir documentación, así que a menudo tendrás que dar instrucciones sobre cómo hacer ciertas cosas. Puedes usar el //imperativo// ("Entonces //pincha// en..."), la //segunda persona// ("Entonces //pinchamos// en..."), la //primera persona// ("Entonces //pincho// en...") o el //impersonal// ("Entonces //se pincha// en..."). No mezcles distintas maneras de dirigirte al lector. | ||
| - | * Revisa los errores gramaticales antes de guardar la página. Si el texto tiene muchos errores perderá credibilidad al dar la impresión de estar poco pensado. | ||
| - | * Desarrolla tu propio estilo. No te esfuerces en escribir de manera que no te sientas cómodo. El texto no resultará natural y será desagradable de leer. | ||
| - | |||
| - | ===== Referencias ===== | ||
| - | * Cuando haya un término que necesite más explicación, añade una página para ese término y enlázala. | ||
| - | * Revisa la página antes de terminar y enlaza los términos principales a otras páginas ya existentes. | ||
| - | * No añadas un enlace cada vez que aparezca el término. Haz un enlace en la primera aparición o en la más prominente y, quizá, añade un enlace a la sección de referencias. | ||
| - | * Ofrece enlaces a las fuentes de imágenes, datos y citas. | ||
| - | * Evalúa el añadir un "Ver más:" al final de la página ofreciendo enlaces a páginas //directamente// relacionadas con el tema de la página. | ||
| - | * Si quieres dar referencias externas con más información del tema o que hayas usado para escribir la página, añade una sección "Referencias" o "Más información" al final, y ofrece una lista de enlaces u otros referentes (por ejemplo: ISBN). Si no lo has hecho en el texto principal, describe brevemente el contenido del enlace. | ||
| - | * Establecer atajos [[dokues>interwiki]] puede ayudar a enlazar a los recursos comunes. | ||
| - | |||
| - | ===== Imágenes y otros medios ===== | ||
| - | * "Una imagen vale más que mil palabras". También quiere decir //más de lo que intentas// decir. Los seres humanos tienden a cuestionar menos la autenticidad de las imágenes que la del lenguaje. Una breve descripción es mejor que nada o que una imagen inapropiada. | ||
| - | * Al igual que en las tablas, añade siempre un título a las imágenes que explique qué quieres mostrar con la imagen. | ||
| - | * Si la imagen no es propia, reseña la fuente (con un enlace si es posible) y el copyright. | ||
| - | * No enlaces imágenes de sitios externos, a menos que esté explícitamente permitido. Esto es por un tema de copyright fundamentalmente, pero puede tratarse de robo de ancho de banda cuando el [[doku>config:fetchsize|cacheo para imágenes externas]] está deshabilitado. | ||
| - | * Si la imagen es mayor de un tercio de la pantalla usa un [[dokues>wiki:syntax#imagenes_y_otros_ficheros|enlace con redimensionado]] para insertar un thumbnail. | ||
wiki/practicas.1479086466.txt.gz · Last modified: 17/11/2021 10:26 (external edit)
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
