Consejos para el estilo, la gramática, el contenido y el SEO (posicionamiento en buscadores)

Estos consejos ayudarán a que su artículo avance durante la edición. Sea amable con su(s) editor(es) y lea esto antes de empezar.

Margen

Regla principal: no sea demasiado elegante, la legibilidad es importante.

  1. No mezcle fuentes mono espaciales con fuentes proporcionales en una oración. Utilice cursiva para el texto especial. Por ejemplo, no escriba dnf install foo en medio de una oración, escriba dnf install foo.

  2. Utilice cursiva para objetos del sistema que mencione en una oración:

    • Elementos de GUI (Interfaz Gráfica de Usuario) o CLI (Interfaz de Línea de Comandos) como un botón o entradas de menú

    • otras indicaciones que el lector debe encontrar en la pantalla

    • nombres de comandos o paquete

  3. Utilice el estilo Preformateado en el editor WordPress para la entrada o salida de línea de comando. Utilice un indicador de shell ($ o #) solo donde genuinamente afecte al significado o establezca la salida aparte de la entrada. También ayuda utilizar negrita para la entrada en si:

    $ command arg1 arg2
    output line 1
    output line 2
  4. Utilice negrita solo para una frase o declaración extremadamente importante.

Consejos de gramática y estilo

  1. Utilice mayúsculas y minúsculas para el título de la publicación y los títulos de los encabezados. No escriba con mayúsculas las palabras en el título de su artículo ni en ningún encabezado, excepto los nombre propios. Esto evita discusiones innecesarias sobre el caso del título, que difiere según la región.

    • Encabezamiento incorrecto: Use Sentence Case for Post Titles in Fedora Magazine

    • Encabezamiento correcto: Use sentence case for post titles in Fedora Magazine

  2. Revise la ortografía y la gramática. A nadie le gustan los comentarios quisquillosos sobre esto. Compruebe su trabajo antes de enviárselo a un editor. Editor: ¡comprueba todo el trabajo, ese es tu trabajo!

  3. Escriba claramente y utilice oraciones más cortas. La brevedad es buena. La claridad es mejor. No hable demasiado cuando se pueda evitar. Si una oración más larga es más fácil de leer, utilice palabras adicionales.

  4. Evite la voz pasiva. La voz pasiva es el uso del objeto de una oración como sujeto. Por ejemplo:

    • Voz activa: Las tropas derrotaron al enemigo.

    • Voz pasiva: El enemigo fue derrotado por las tropas.

  5. Tenga cuidado con los gerundios (palabras -ndo). Normalmente indican la voz pasiva. Vuelva a escribir su oración para hacerla más fuerte. Por ejemplo:

    • Voz débil y pasiva: Configurando la opción de configuración foobar hará que la aplicación escuche en todas las interfaces.

    • Voz fuerte, activa: Establezca la opción de configuración foobar para hacer que la aplicación escuche en todas las interfaces.

  6. Evite el tiempo futuro innecesario. A menos que esté hablando de planes o publicaciones futuras, el tiempo presente es mejor.

    • Tiempo futuro innecesario: Cuando usted selecciona Ejecutar, su programa arrancará.

    • Tiempo presente: Cuando usted selecciona Ejecutar, su programa arranca.

  7. Evite el uso excesivo del verbo to be (ser) en las oraciones. Demasiado uso de es, será o puede ser hace que las oraciones sean débiles y flojas. Intente utilizar la forma verbal de palabras que ha utilizado en otras partes de la oración. A menudo puede simplemente omitir palabras o usar la forma imperativa (de orden o consejo) de la oración.

    • Débil: Zambone es una aplicación que se usa para administrar sus documentos privados en un servidor.

    • Fuerte: Zambone administra sus documentos privados en un servidor. O: Utilice Zambone para administrar sus documentos privados en un servidor.

    • Débil: Cuando configure un servidor de archivos, es importante planificar cuidadosamente la estructura de directorios.

    • Fuerte: Planifique la estructura de directorios del servidor de archivo cuidadosamente antes de configurarlo.

  8. Utilice el Inglés estadounidense para la ortografía y otras diferencias internacionales. El Inglés estadounidense en la lengua franca del Proyecto Fedora en general.

  9. Tenga un flujo fluido desde la información general hasta las instrucciones específicas. Si no está seguro de como estructurar su artículo de esta manera, consulte nuestra plantilla inicial.

Consejos de contenido

Estos consejos son sobre las cosas que hacer — y evitar — en lo que les dice a los usuarios que hagan. Recuerde que miles de lectores confían en Fedora Magazine para decirles como llevar a cabo sus tareas. Sea responsable y servicial, defienda las mejores prácticas y respete la seguridad y la elección del usuario.

  1. Deje los archivos empaquetados en paz. Los procesos no deberían implicar la edición de archivos en carpetas del sistema como /usr o /lib*. Edite /etc o una configuración específica del usuario en el directorio home.

  2. Prefiera software libre cuando sea práctico (y software empaquetado oficialmente siempre que sea posible). El Magazine aún puede cubrir software que no sea FOSS (Software Libre y de Código Abierto) para ser utilizado en Fedora, donde sabemos o sospechamos que el software es muy popular y útil entre los usuarios de Fedora. (Google Chrome es un buen ejemplo.) Pero si su artículo está cubriendo un proceso general, use software FOSS.

  3. Utilice libvirt/KVM en los consejos, no VirtualBox u otros hipervisores. Con frecuencia la gente que viene de otras plataformas tiene experiencia en VirtualBox. Sin embargo, el hipervisor KVM y libvirt en Fedora son FOSS y parte de la plataforma. Utilícelos, escriba sobre ellos, ámelos.

  4. A menos que sea necesario, utilice distribuciones de la familia Fedora. Fedora Magazine promueve Fedora. A no ser que el punto de su artículo sea explicar específicamente un mecanismo de distribución cruzada, utilice instalaciones, contenedores o distribuciones dentro de su familia (Fedora, CentOS, RHEL).

  5. El software Copr debe ir acompañado de una advertencia. El sistema de construcción Copr no está administrado por el equipo de lanzamiento de Fedora y no proporciona construcciones oficiales de software. Si usted cubre algún software de Copr, compruebe que no haya una compilación oficial. Si no, incluya una declaración como esta: Copr is not officially supported by Fedora infrastructure. Use packages at your own risk (Copr no está soportado oficialmente por la infraestructura Fedora. Utilice los paquetes bajo su responsabilidad).

  6. Evite el lenguaje excluyente o problemático. Estos son ejemplos de la terminología a evitar siempre que sea posible en los artículos:

    1. lista negra/lista blanca — Utilice lista permitida/lista denegada en su lugar, los que es más directamente descriptivo del propósito.

    2. maestro/esclavo — Utilice primario/secundario, primario/replica, activo/pasivo, activo/en espera u otra construcción similar.

  7. Pruebe sus procesos. Si es posible, utilice una VM (Máquina Virtual) invitada nueva — o al menos una cuenta de usuario nueva. Ejecute su proceso de principio a final para comprobar que funciona. Arregle, enjuague y repita.

  8. Utilice el estilo correcto para terceros. Los nombres de compañías, proyectos y tecnologías no siempre siguen las reglas de estilo de las típicas palabras en Inglés. Elija el estilo utilizado por los sitios web autorizados cuando no esté seguro. Si las fuentes autorizadas utilizan estilos inconsistentes, utilice su mejor juicio. Una lista no exhaustiva:

    1. Copr en lugar de COPR

    2. NVIDIA en lugar de Nvidia or nVidia

    3. Perl en lugar de PERL

    4. Red Hat en lugar de Redhat o RedHat

    5. ThinkPad en lugar de Thinkpad

Consejos para imágenes y capturas de pantalla

  1. Utilice un Fedora Workstation estándar nuevo, no su escritorio o configuración personal. (Es mejor hacer una VM con una instalación nueva Fedora Workstation y haga los pasos allí.) Si muestra algo que depende de otro escritorio, haga una instalación nueva y úsela.

  2. Establezca la resolución de pantalla a un valor razonable pero no demasiado alto, como 1280x960 o 1280x800.

  3. Si solo muestra una ventana del navegador, hágala bastante grande en pantalla y haga una captura de pantalla solo del navegador. (Sugerencia: ¡puede usar la aplicación Screenshot para esto!)

  4. Si solo está mostrando una aplicación, utilice el tamaño predeterminado de la aplicación para hacer la captura de pantalla.

  5. Cargue y utilice ese medio original en su artículo. Si la captura es grande, como una gran ventana de navegador, aplicación o la pantalla completa, elija una miniatura de tamaño medio y deje que WordPress maneje la conversión.

Consejos WordPress

  1. Utilice un título sencillo y relevante. Preferiblemente esto debería ser una llamada a la acción, como Build a widget using GTK+ (Crear un widget usando GTK+) o una descripción de la lista, como 5 fun games in Fedora (5 divertidos juegos en Fedora). El título afecta a los motores de búsqueda y lleva a más sugerencias y a una clasificación más alta de la página. Esto ayuda a dirigir el tráfico hacia el Magazine.

  2. Proporcione una imagen destacada. Vea en la información de aquí consejos sobre las imágenes destacadas. También puede pedir a los editores que le asignen esto. Si usted hace su propia imagen, intente que coincida con el estilo de las otras imágenes. Use los recursos proporcionados en la guía de imagen destacada. No agregue sus propias fuentes ni se desvíe de la guía.

  3. Utilice buenas prácticas de SEO. Utilice el complemento SEO proporcionado para maximizar la clasificación de búsqueda del artículo. Apunte a una clasificación “verde” en el cuadro Publish (Publicar) en la parte superior derecha de la ventana de edición del artículo. Siga estas directrices:

    • Introduzca una palabra clave significativa en el cuadro SEO debajo de su artículo. (La mayoría de los artículos no deberían usar Fedora.)

    • Si el fragmento no ofrece una introducción o resumen eficaz en el resultado de la búsqueda de muestra vuelva a escribirlo.

    • No sienta que tiene que eliminar todas las advertencias. Una clasificación general “verde” es el único objetivo.

  4. Utilice la opción Edit as HTML (Editar como HTML) al pegar en bloques preformateados. Se sabe que las versiones actuales de WordPress eliminan las marcas de almohadilla (#) y los espacios en blanco iniciales cuando el contenido se pega en bloques preformateados. Algunos caracteres no alfanuméricos también pueden resultar confusos (&, <, >, etc.). Usar la opción Edit as HTML (que aparece debajo de los puntos suspensivos verticales) antes de pegar contenido en el bloque parece solucionar el problema. Asegure de pegar su contenido entre las etiquetas <pre> y no las sobrescriba. Después de pegar su contenido, vuelva al modo visual utilizando la opción Edit visually (Editar visualmente) para ver una mejor representación del resultado final, lo verá como el lector.

Otras sugerencias

¿Tiene una idea para una mejor escritura? Debata con los editores en el canal Matrix #magazine:fedoraproject.org en chat.fedoraproject.org.