Recojo en este post algunas normas de estilo que hemos ido comentando en el aula, son recomendaciones útiles para la mayoría de artículos. Buscamos transmitir una imagen común.
- Propiedad intelectual: si algo ya está escrito en otro sitio es mejor referenciarlo con un hipervínculo, en el post podemos añadir observaciones, ampliaciones, revisiones, etc pero mantenemos la autoría. Esto ocurre tanto con contenidos como con imágenes, vídeos, audios, etc. Este punto tiene dos vertientes; respetar la autoría de un contenido y no perder tiempo en hacer algo que ya está hecho, interesa más tu experiencia. Más información en http://www.ugr.es/~derechosdeautor/derechos_autor.html
- En lo posible hay que contar tu propia experiencia y dejar claro si se trata de un artículo teórico o no, o qué partes han sido probadas por tí y cuales solo describes o las planteas como ampliación en un futuro.
- En los artículos técnicos es muy importante indicar los máximos datos del entorno de pruebas que hayas utilizado: información del sistema operativo, del hardware, de las aplicaciones, etc. (versión, 32/64 bits, …). Pensar en que cualquiera que lea tu post tiene que poder llegar a las mismas conclusiones o resultados que los que has indicado en el post. Hay herramientas que dan información del sistema, podrías incluir capturas de pantalla, informes, logs, ….
- Perfil: poner un nombre que te identifique.
- Ortografía y gramática: revisar la ortografía y la gramática para evitar errores. Puedes copiar el texto a un editor (OpenOffice, Office, …) y realizar la comprobación de ortografía y gramática. También puedes utilizar el editor ortográfico incluido en el editor de post:
Ortografía en Post - Formato y colores: utilizar la fuente y el tamaño por defecto. No utilizar colores para los textos a no ser que sea necesario para la explicación, mejor destacar con negrita o itálica. Alinear a izquierda y derecha los párrafos. Utilizar títulos para separar partes de un artículo.
- Si el artículo es muy extenso utilizar la opción «Leer Más» en el editor de post.
- Imágenes: escalar las imágenes a unos tamaños adecuados de forma que sean visibles en una pantalla normal (menores de 500×500 px). Si no tienes un software de retoque fotográfico instalado puedes utilizar alguno online, por ejemplo http://fotoflexer.com/app/index.php?lang=es-ES. Cuando se trata de capturas de pantalla, no incluir el fondo u otros elementos para evitar distraer al lector, a no ser que sean importantes en la explicación. No abusar del uso de imágenes, podemos resumirlas utilizando gif animados (p.e.: https://blog.iesvjp.com/?p=381). Valorar la posibilidad de utilizarlas con texto alrededor para acortar el post.
- Hipervínculos: probar que funcionan y que incluyan un título descriptivo. Valorar la opción de que se abran en una ventana nueva.
- Vídeos de Youtube: si solo lo quieres referenciar utiliza un hipervínculo, pero si lo quieres incrustar en el artículo utiliza el icono «youtube» del editor de post
. Entre las etiquetas que ha añadido pones la URL o símplemente el código del vídeo. - Descargas: puedes utilizar la opción «añadir descargas del menú superior que aparece cuando editas una entrada. Documentación en http://mikejolley.com/projects/download-monitor/ Un ejemplo: [download id=»17594″]
- Código: para evitar errores al lector de tu artículo es muy importante diferenciar qué parte es código o comandos dentro del contenido, para ello puedes utilizar el plugin Crayon. Para añadir código a una entrada utiliza <> en el editor.
[crayon lang=»java»]
// A sample class
class Human {
private int age = 0;
public void birthday() {
age++;
print(‘Happy Birthday!’);
}
}[/crayon]