Guía de Estilos de PuntoTech

El formato importa

Photo by Aron Visuals on Unsplash

Todo el equipo de editores profesionales de PuntoTech siguen escrupulosamente una guía de estilos, que ha de cumplirse para que cualquier artículo pueda ser publicado.

¿Para qué hacemos esto?

Para que haya uniformidad y armonía en todas nuestras publicaciones, y para asegurar el estándar de calidad que representa a PuntoTech. Para ello os presentamos una serie de consejos y puntos a seguir a todos los escritores (o aspirantes a escritores) de PuntoTech:

Títulos y Subtítulos

• El artículo debe tener título y subtítulo.
• Para la capitalización de los títulos, utilizamos el estilo determinado por las normas APA.
• La capitalización de los títulos debe ser la siguiente:
• Todas las palabras mayores han de estar capitalizadas. Se consideran palabras mayores: sustantivos, verbos, adjetivos, adverbios, pronombres y toda palabra de más de cuatro letras.
• Las palabras menores no se capitalizan. Se consideran palabras menores: conjunciones, preposiciones cortas, artículos y toda palabra de tres letras o menos.
• Title Case Converter es una herramienta útil si no estamos seguros.
• En el subtítulo, las mayúsculas han de utilizarse como en cualquier frase: Se capitaliza sólo la primera palabra de la frase, con la excepción de nombres propios, que también se capitalizan.
• Si el título es una pregunta, debe expresarse en forma de pregunta retórica, omitiendo los signos de interrogación.

Cómo formatear el código y los enlaces

• Los nombres de variables, ficheros, URLs, directorios, clases etc. deben tenereste formato . Para formatear así, resaltamos la palabra/frase haciendo doble click sobre ella, y presionando la tecla `.
• Todos los fragmentos de código deben estar en un gist de Github. Para ello, se crea un gist público, se pega la URL de dicho gist en el artículo y se presiona enter. De esta manera se visualizará el fragmento de código con la sintaxis apropiada. Nota: Medium tiene un bug, donde, en modo edición, sólo se verán las primeras 11 del gist. Una vez publicado el artículo, el gist se verá perfectamente.
• Se recomienda proporcionar enlaces a bibliotecas, lenguajes, frameworks etc. que no sean muy conocidas, para que los lectores puedan informarse acerca de ellos si así lo desean. Con proporcionar un enlace a los recursos una sola vez, es suficiente. Ej: Si mencionamos el lenguaje Nim cinco veces en el artículo, sólo se enlazará la primera referencia.

Imágenes

Utilizar buenas imágenes en el artículo es muy importante. No sólo por mantener una estética cuidada, también por hacerlo más atractivo para los lectores.

• Se debe utilizar una imagen de portada para el artículo. Si se utilizan imágenes de terceras personas, se tiene que mencionar al autor. Recomendamos utilizar páginas como Unsplash, que nos proporcionan imágenes con licencia para compartir, y además, nos lo ponen muy fácil a la hora de mencionar al autor.
• Está completamente prohibido utilizar imágenes ofensivas, discriminatorias, racistas, homófobas, sexistas o que puedan herir la sensibilidad del lector.
• Siempre hay que citar la fuente de la imagen.

Política

PuntoTech es una publicación completamente apolítica. Nuestro objetivo es proporcionar contenido técnico/tecnológico a nuestros lectores. Existen multitud de espacios para hablar/debatir/discutir sobre política. PuntoTech no es una de ellos.

Por tanto:

• No se deben utilizar imágenes, frases o ejemplos que hagan referencia a la política directa o indirectamente. Ej: Utilizar nombres/logotipos/frases de partidos políticos.

Algunos consejos más

En esta sección os proporcionamos una serie de consejos que os pueden resultar útiles:

• No es obligatorio, pero agradecerle al lector el haber leído el artículo siempre resulta agradable.
• Si el artículo consta de varias partes, se deben enlazar las demás partes para que el lector pueda seguir la serie de artículos completa.
• Es buena práctica acabar el artículo con una breve reflexión sobre el contenido, un pequeño resumen, un chiste o un agradecimiento. Algo para que el lector se vaya satisfecho.
• Se pueden añadir enlaces a vuestras cuentas de Twitter, LinkedIn o Github, siempre y cuando no se considere spam.
• Todas las secciones deben estar claramente diferenciadas. Para ello, se deberá seleccionar la opción Add a new part, que generará un separador (compuesto tres puntos.)
• Asegúrate de que tu artículo tiene un tiempo de lectura de al menos tres minutos.

Conclusión

Gracias a todos por leer esta guía, desde el equipo de PuntoTech esperamos que os haya resultado útil. Si tenéis cualquier duda, no dudéis en escribírnosla en los comentarios o en poneros en contacto con nosotros en puntotechacademy@gmail.com.