Instrucciones y estilo de redacción de artículos


En este artículos presentamos la primera versión, que será modificada y
mejorada con el tiempo, de las instrucciones y guías básicas para publicar
artículos en el web de Bulma. Aunque las guías de estilo no son de seguimiento
obligatoria, son recomendables para facilitar la lectura.

La cantidad de accesos, visitas y autores al Web de Bulma ha aumentado
considerablemente en los últimos meses, llegando a posicionar este web como uno
de los más visitados de las Balears. Por ello, y para facilitar la
comprensión, facilitar las búsquedas de información y  servir de ayuda a
los lectores, publicamos estas simples instrucciones y normas que no sólo
ayudarán a los lectores, sino también a los autores.
Licencia de los artículos (sin determinar todavía)
A menos que se indique lo contrario en el texto del artículo, se asume y
acepta que el artículo se publica bajo la GNU
Free Documentation License
. Al ser el derecho de autor un derecho
inalienable en España, se aplicarán las leyes de derechos de autor Españolas
y Europeas que prevalezcan. 
Tipos de Artículos
Por cuestiones de clasificación, aunque sean muy simples , los artículos
están divididos por secciones:

  • Noticia: esta sección está pensada para poner noticias que
    consideremos importantes. Es recomendable, además de poner los enlaces a
    las noticias originales, que se dé un resumen y explicación de lo que se
    trata. No está mal poner la opinión del autor.
  • Breve: en esta sección deben ponerse los enlaces a noticias donde
    no hagamos un resumen o explicación elaborada como la anterior. Esta
    sección es ideal si has leído un par de artículos interesantes y quieres
    compartirlos con Bulma. Tómate un par de minutos y escribe un par de
    párrafos para que no enteremos rápidamente de que se trata.
  • Truco: esta es una de las más interesantes porque se pueden
    aprender cosas nuevas de los trucos de los autores. Explicad para que sirve,
    como se ejecutan los comandos o programas y una breve explicación de lo que
    hace cada uno.
  • Enlace: sí solo queremos poner un o unos enlaces interesantes,
    usad esta sección. No olvidéis de poner un breve resumen de lo que se
    trata y/o vuestra opinión.
  • Participa: esta sección está dedicada a las noticias o eventos
    relacionados con la Asociación o con eventos Linux que nos toquen de cerca.
    Las diadas, charlas, conferencias deben ir en esta sección.
  • Proyecto: indicada si estás haciendo algo relacionado con Linux o
    programación y quieres invitar a la gente a participar en tu proyecto. O
    simplemente si quieres informar. Es importante que pongas un enlace a donde
    se pueda encontrar la información más actualizada de dicho proyecto. Vale
    también para proyectos de amigos o conocidos.
  • Artículo: esta sección está dedicada a los artículos más
    largos y que normalmente suelen ser tutoriales, pequeños cursos,
    explicaciones más complejas de instalación o configuración de software o
    utilidades. Usa también esta sección si quieres expresar una opinión
    razonada de cualquier tema relacionado con Linux o Software Libre. 
  • WebBulma: esta sección está reservada para los artículos, cortos
    o largos, de cualquier cosa que tenga que ver con desarrollo o eventos
    importantes del Web de Bulma (por ejemplo este artículo).
  • Manoletada: esta sección son para cosas curiosas, normalmente
    fallos muy tontos u obvios de webs o sistemas grandes empresas.
    Obviamente nuestros preferidos son los fallos de Microsoft o de la
    Administración :-).
  • Seguridad: sección dedicada a anuncios de seguridad, sobre
    todo si son graves.

Futuras versiones de Bulma quizás introduzcan nuevos tipos de secciones o
tópicos para facilitar las consultas.
Estilo de redacción
Como bien lo explica
Jacob Nielsen, la gente raramente lee las páginas web palabra a palabra, sino
que más bien hacen un barrido o lectura rápida. Hay varias razones, entre las
más importantes está que la lectura en la pantalla cansa bastante más que
hacerlo sobre un papel y la lectura en el web es muy dinámica, siempre hay otro
enlace o página a visitar, es la propia
naturaleza del web
.
Como resultado de la forma de leer, hay que seguir ciertas normas fáciles:

  • palabras claves o importantes resaltadas
    (enlaces, negritas y cambios de color)

  • sub-títulos con significado del contenido
  • uso de  listas
  • una idea por párrafo, los lectores se saltean ideas
    adicionales si no son claras en las primeras palabras del párrafo

  • usar el estilo de pirámide
    invertida
    , es decir, comenzar con las conclusiones

  • la mitad de las palabras que usarías (o menos) para
    escribirla sobre papel. 

Etiquetas HTML
Para seguir estas normas y las que vienen a continuación, no hace falta ser
un experto en HTML, basta conocer un buen editor HTML o bien las etiquetas
básicas de HTML: <P>, <BR>, <EM>, <B>, <H2>,
<H3>…<H6>, <PRE>, <OL>, <UL>, <LI>, <I>,
<IMG>, <A>. 
Con estas pocas etiquetas podremos realizar prácticamente cualquier tipo de
artículo y con un estilo adecuado y fácil de leer.
Carga y edición de los artículos
La carga y edición de los artículos es bastante sencilla y directa. Se pone
el texto (plano o HTML) en los distintos campos. Es siempre recomendable usar
HTML, pero si no te gusta, no lo conoces o no tienes un editor adecuado, carga
el texto en formato texto normal e indícalo en el campo Formato. No te
olvides de indicar que tipo de artículo estás poniendo (Enlace, Breve, Truco,
etc.).
Lo más recomendable es escribir todo el artículo en un editor en tu propio
ordenador, luego ir a visualizar el código HTML, hacer un copy&paste en los
campos correspondientes. No te olvides que la parte de cabeceras que suelen
poner los editores (<head><body>) no deben ir en el formulario, ya
que dichas secciones son generadas automáticamente por los programas de Bulma.
Recuerda que siempre se cometen errores, el artículo nunca
quedará bien a la primera, así que léelo en el web, verifica los errores y corrígelos.
Ahora unas breves explicaciones de que poner en cada campo y como insertar
imágenes, enlaces y tablas.
Longitud de los títulos
Es mejor no pasarse con la longitud de los títulos, pero tampoco hay que
poner tan pocas palabras que no den idea de lo que se trate. Lo mejor es en el
título aparezcan las palabras claves más importantes. Así de paso facilitamos
a las herramientas de búsqueda (incluida la de Bulma) para que asigne un peso
más adecuado. Tened en cuenta que el título que pongáis será el título de
la página del artículo.
Longitud de los resúmenes
Lo mejor es que el resumen que se pone (y se muestra en la página principal)
no supere de uno o dos párrafos pero que tampoco sea muy corto. Se debe
explicar en pocas líneas el tema que trata el artículo y la conclusión del
mismo.
Si el usuario está interesado en el tema, seguirá en enlace, sino es mejor que
no pierda tiempo y dinero. Es mejor tener por lo menos unas cinco líneas, con
menos es imposible dar una idea. Tened en cuenta que el resumen se especifica
dentro del meta “description” de la página para ayudar a los
buscadores.
Palabras claves
Es importante que pongas las palabras claves apropiadas, ayudan muchísimo a
las búsquedas. Bulma te muestra dos palabras claves, “linux, kernel”,
pero sólo son tentativas y debes borrarlas si no coinciden con las de tu
artículo. Las palabras claves pueden ser simples o compuestas y separadas por
comas (“,”). Por ejemplo:
linux, baleares, open source, código abierto, política
Longitud de los artículos y paginación
El cuerpo del artículo es la parte principal del artículo. Un
artículo sin un cuerpo consistente no vale nada. Cuando un lector selecciona
un artículo para leer (después de leer el título y resumen), espera que
dicho artículo tenga el contenido que le interesa y por lo tanto debe estar
relacionado con el título y dar un explicación mas detallada que el
resumen.
Aunque Bulma acepta artículos bastantes largos (2^24
caracteres), no es recomendable superar unos 64KB por
página, ya que de otra forma la página tardará bastante en cargarse y
visualizarse (ya estamos trabajando para permitir artículos de varias
páginas). Si escribes un artículo largo lo mejor es que lo separes en páginas, para ello basta con introducir el
pseudotag <PAGE> en el lugar donde quieres que el
sistema lo separe en una página distinta. También puedes separar un
artículo muy largo en varios artículos independientes y relacionados entre
sí. En éste caso, no está mal tampoco que se incluya una pequeña lista con
el título y los enlaces de cada artículo al principio o final de cada
uno.
Si tu artículo tiene
secciones bien diferenciadas (los artículos medios o largos deberían
tenerlas), usa <H2><H3>… El uso de <H1> no es
recomendable porque la fuente es muy grande y confundiría con otras partes
de la página.  Si las secciones tratan de temas claramente
diferenciadas y quieres que sea clara la diferenciación, no temas en usar un
barra horizontal para separarlas (<HR>), pero no te excedas con ellas
porque pueden hacer la lectura muy pesada. En este caso es recomendable
separar en páginas.
Inclusión de código fuente o comandos
Para poner código o comandos que se usan o explican es mejor usar la
etiqueta <pre>. Pero hay que tener mucho cuidado, el ancho de las
columnas es limitado, y los navegadores no cortan la línea si en el original no
hay ningún <Enter>, aunque se haya extralimitado en el ancho. El
resultado es que la página de Bulma se sale de la pantalla y hay que empezar a
usar la horrible barra de desplazamiento horizontal.
Como recomendación, es mejor no poner más de 70 u 80 caracteres en
una misma línea. Si te excedes de esos caracteres, lo mejor es introducir un
salto línea directamente. Si puede llevar a confusión en los casos de comandos
del shell, usar el “” al final para indicar que continúa en la
siguiente línea.
Si ha pesar de todo, es “imposible” hacerlo, deja que cada
navegador lo resuelva como pueda y usa la etiqueta <tt>. Con esto
pasaremos a fuente sin serif (normalmente Courier) y los “copy&paste”
funcionarán perfectamente.
Inclusión de imágenes
Por ahora Bulma no soporta la inclusión de imágenes (todavía, pero todo
llegará), pero no hay problemas si tienes un servdior web o tu página
personal. Puedes indicar la inclusión de las imágenes mediante la etiqueta
<img> con el src apuntando al URL completo (no te olvides del http://servidor…)
donde se encuentra la imagen.
Inclusión de tablas
SI quieres incluir tablas lo mejor es que le pongas un borde  (<TABLE
BORDER=1>) para que quede diferenciada del texto principal y te ayuden a
corregir posibles (y frecuentes) errores en las etiquetas. Los errores en las tablas pueden llegar a dejar
toda la página completamente ilegible. El borde es de gran ayuda.
Si la tabla sigue la “secuencialidad” del texto, insértala en el
lugar que corresponda, e intentando que quede centrada. Un pié o título de
tabla puede ayuda mucho a la comprensión.
Si la tabla tiene texto que es adicional, importante pero no sigue una
secuencia lógica, la puedes poner alineada a derecha o izquierda.
Especificación de enlaces externos e internos
Es recomendable que haya enlaces en el texto, pero no te olvides de poner el
URL completo, con el http:// incluido, si es un enlace externo a Bulma. De otra
forma será tratado como un enlace interno y fallará. 
Si lo que quieres es apuntar a otro artículo de Bulma, no indiques el URL
completo (hay gente que usa  otro puerto o incluso otro nombre) sino
solamente body.phtml?nIdNoticia=N, donde N es el número de artículo.
Artículos Relacionados
Una vez que has cargado y revisado tu artículo (normalmente se necesitan dos
o tres correcciones) dedícate a indicar los artículos relacionados que haya en
Bulma. Eso se hace con la opción Relaciones o Noticias relacionadas
e indicando el número de artículo con el que queremos relacionar. 
La posibilidad indicar noticias relacionadas es muy importante, ya que
permite al lector continuar leyendo del tema que le interesa, quizás con
información complementaria o actualizada. Además ayuda a que Bulma tenga mas
páginas leídas por cada visita. 
Son muy tristes las visitas que llegan de un
buscador, ven que no era lo que realmente le interesaba y se van inmediatamente.
Con las relacionadas solventamos parcialmente ese problema.
Las opciones son:

  • Misma temática: con esta relación se indican los artículos que
    hablan más o menos del mismo tema o los que te gustaría que se leyesen
    junto con al artículo que acabas de poner.
  • Continuación: esta relación es ideal si has escrito un artículo
    en varias partes (no hace falta que lo hagas al mismo tiempo, pueden pasar
    días o semanas) y quieres indicar que éste es continuación de otro
    artículo.
  • Reemplaza: Sólo puedes hacerlo si eres el
    autor del artículo al que pretendes reemplazar. Está pensada sobre todo para aquellos casos en que se han
    cambiado cosas (como pasar Bulma de Postgres a MySQL) y hacemos un nuevo
    artículo de instrucciones o simplemente porque la informática evoluciona,
    acabáis de escribir algo más actualizado y mejorado. Los artículos son
    parte de la historia de Bulma y es mejor no borrarlos, sino reemplazarlos,
    siempre y cuando el otro no tenga errores o haya sido “correcto”
    en la fecha en que fue publicado.
  • Actualiza: ideal si tratamos el mismo tema que otro/s artículos
    con información más actualizada y quizás complementaria al anterior.

No te olvides que las relaciones son en ambos sentidos, si indicas que tu
artículo está relacionado con otro, dicha relación aparecerá cuando se
lean ambos artículos
.
Actualización de fecha
Verás que abajo del formulario de edición de artículos hay una opción de
Actualizar fecha. Dicha opción, si está seleccionada, indica a Bulma que debe
marcar la fecha y hora de la modificación que está haciendo. El efecto más
importante es que el artículo se pondrá arriba de todo en la página principal
y permanecerá en ella por varios días.
La decisión de hacerlo o no es totalmente tuya, pero es recomendable que
sólo lo hagas si acabas de agregar más información que puede ser importante
para su lectura inmediata por la gente que visita la página regularmente. No lo
hagas por el puro placer de ver tu artículo en la primera página. Piensa en
los demás.
Última recomendación
Lee el artículo que acabas de poner y corrígelo, seguro que tiene
errores fácilmente remediables. Y si los pocos días encuentras más
errores, corrígelos, piensa que la mayoría de la gente que leerá tu artículo
no lo ha hecho todavía, lo harán cuando el artículo haya sido indexado por
los buscadores. Pasarán varias semanas o meses antes que eso ocurra.

Este post ha sido traido de forma automatica desde https://web.archive.org/web/20140625063149/http:/bulma.net/body.phtml?nIdNoticia=720 por un robot nigromante, si crees que puede mejorarse, por favor, contactanos.


Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.