Proyecto:Manual de estilo

De doc.ubuntu-es
(Diferencias entre revisiones)
Saltar a: navegación, buscar
(nota borrador)
(e)
 
(No se muestran 5 ediciones intermedias realizadas por 2 usuarios)
Línea 1: Línea 1:
{{Nota| '''Esto es solo un borrador''' en proceso de edición, las normas de edición de este sitio aun están por definir (aunque las antiguas han quedado abolidas). Por favor, no edites esta página, cualquier comentario, crítica o sugerencia, hazla en la página de discusión.}}
 
 
<div style="float:right;">__TOC__</div>
 
<div style="float:right;">__TOC__</div>
 +
 
=Manual de estilo=
 
=Manual de estilo=
Para que todos los artículos de este sitio mantengan un estilo o formato unificado es necesario establecer ciertas reglas a la hora de la creación de los mismos, facilitando así la lectura y el entendimiento a todos los usuarios y la organización de los contenidos del wiki.
+
Para que todos los artículos de este sitio mantengan un estilo o formato unificado es necesario establecer ciertas reglas a la hora de la creación de los mismos, facilitando así la lectura y el entendimiento a todos los usuarios y la organización de los contenidos del wiki. Se mencionan aquí ciertos aspectos importantes a la hora de crear páginas o de editar las mismas.
  
Se mencionan aquí ciertos aspectos importantes a la hora de crear páginas o de editar las mismas.
+
==Escribe en correcto español==
  
== Convenciones de nombres ==
+
* Aunque puedan establecerse excepciones, se consideran fuentes primarias de referencia las obras de la [[W:Asociación de Academias de la Lengua Española|Asociación de Academias de la Lengua Española]].
 +
* Procura no cometer faltas de [http://www.rae.es/rae/gestores/gespub000039.nsf/(voanexos)/arch6947C6DBCDECF191C1257800004EF7D9/$FILE/InteriorOrtografia.pdf ortografía] ni gramaticales.
 +
* Evita en la medida de lo posible los localismos.
 +
* Exprésate de la forma más simple y clara que puedas.
 +
** La exposición de un tema debería constar de las siguientes fases: introducción, desarrollo y conclusión.
 +
** Solo un tema o idea por párrafo.
 +
** Oraciones cortas, simples y bien estructuradas: sujeto, verbo y complementos.
 +
** Haz tu artículo fácil de leer, incluye signos de puntuación, una línea en blanco entre párrafos, etc.
 +
* Evita el lenguaje malsonante.
  
Tanto en los nombres de las páginas como en el modo de escribir, debemos utilizar siempre nombres en español/castellano, por ejemplo, en vez de utilizar términos como "ripear Cd", utiliza "extraer CD".
+
* No utilices palabras como Actualmente, ahora, etc.
 +
 
 +
== Estructura de la página ==
 +
 
 +
Siempre que la página tenga más de 3 o 4 párrafos, el artículo deberá estar separado por secciones. Los títulos de las secciones tienen que usar la ortografía general respecto a mayúsculas y minúsculas, es decir, sólo se usarán mayúsculas para las iniciales de los nombres propios y para la primera letra del título. Consulta la sección de secciones en la [[Como_editar_páginas#Secciones|guía de edición]].
 +
 
 +
El software del wiki crea automáticamente un índice con las secciones llamado TOC. Salvo las razonables excepciones, el TOC debería mostrarse siempre, arriba a la derecha. Puede hacerse fácilmente incluyendo la siguiente marca en la primera línea de la página: <nowiki><div style="float:right;">__TOC__</div></nowiki>
 +
 
 +
Además, siempre que sea posible, deben componerse de texto simple sin formato -negrita o cursiva-, sin enlaces ni imágenes.
 +
 
 +
== Tú vs usted ==
 +
 
 +
El tuteo es un dilema clásico al escribir documentación ¿cómo hemos de tratar al lector? ¿de tú o de usted?
 +
 
 +
;Tuteo
 +
«para instalarlo ''debes hacer'' esto y después lo otro.»
 +
;De usted
 +
«para instalarlo ''debe hacer'' esto y después lo otro.»
 +
;Impersonal
 +
«para instalarlo ''debe hacerse'' esto y después lo otro.»
 +
 
 +
En principio, debería usarse un discurso impersonal. También puede ser apropiado el tuteo en guías paso a paso.
  
 
== Creación de páginas ==
 
== Creación de páginas ==
Línea 14: Línea 43:
 
Es necesario y muy importante que pensemos bien el título que le vamos a poner a nuestra página antes de crearla. Antes de ello, ten en cuenta estos puntos:
 
Es necesario y muy importante que pensemos bien el título que le vamos a poner a nuestra página antes de crearla. Antes de ello, ten en cuenta estos puntos:
  
* Los títulos de las páginas serán también la URL de estas mismas. Se pueden añadir tildes, pero '''evita incluir caracteres extraños''', pues las URL no los interpretan bien.
+
* Los títulos de las páginas serán también la URL de éstas mismas. Se pueden añadir tildes, pero '''evita incluir caracteres extraños''', pues las URL no los interpretan bien.
* El título ha de ser completamente específico y evitando información innecesaria. Por ejemplo, si queremos crear una página para el reproductor de música Totem, el título debe ser ese y solo ese, no es necesario llamarla “reproductor de música totem” puesto que para añadir esa información ya tenemos la categoría [[:Categoría:Reproductores de música]].
+
* El título ha de ser completamente específico y evitando información innecesaria. Por ejemplo, si queremos crear una página para el reproductor de música Totem, el título debe ser ese y solo ese, no es necesario llamarla “reproductor de música totem”, puesto que para añadir esa información ya tenemos la categoría [[:Categoría:Reproductores de música]].
  
== Estructura de la página ==
+
=== Convenciones de nombres ===
  
Siempre que la página tenga más de 3 o 4 párrafos, el artículo deberá estar separado por secciones. Los títulos de las secciones tienen que usar la ortografía general respecto a mayúsculas y minúsculas, es decir, sólo se usarán mayúsculas para las iniciales de los nombres propios y para la primera letra del título. Consulta la sección de secciones en la [[Como_editar_páginas#Secciones|guía de edición]].
+
Tanto en los nombres de las páginas como en el modo de escribir, debemos utilizar siempre nombres en español/castellano, por ejemplo, en vez de utilizar términos como "ripear Cd", utiliza "extraer CD".
 +
 
 +
== Convenciones de marcado de texto==
  
== Líneas de código ==
+
=== Líneas de código ===
  
 
Las líneas de código son las líneas donde introducimos por ejemplo comandos para la terminal.
 
Las líneas de código son las líneas donde introducimos por ejemplo comandos para la terminal.
Línea 37: Línea 68:
 
== Imágenes ==  
 
== Imágenes ==  
  
No utilices nunca imágenes superiores a 400x300, pues deformarán el wiki sobretodo a las personas que utilicen una configuración de pantalla pequeña. No utilices imágenes indiscriminadamente. Utiliza solo las imprescindibles o mínimamente necesarias para el entendimiento de la documentación.
+
No utilices nunca imágenes superiores a 400x300, pues deformarán el wiki sobre todo a las personas que utilicen una configuración de pantalla pequeña. No utilices imágenes indiscriminadamente. Utiliza solo las imprescindibles o mínimamente necesarias para el entendimiento de la documentación.
  
 
== Categorías ==
 
== Categorías ==
  
Puedes incluir más de una categoría a tu artículo, pero no incluyas en el mismo artículo una categoría una subcategoría a la vez. Lo correcto es incluir solo la subcategoría más baja, puesto que esto incluirá automáticamente el artículo en la categoría padre.
+
Puedes incluir más de una categoría a tu artículo, pero no incluyas en el mismo artículo una categoría y una subcategoría a la vez. Lo correcto es incluir solo la subcategoría más baja, puesto que esto incluirá automáticamente el artículo en la categoría padre.
 
+
== Sobre párrafos, signos de puntuación, etc ==
+
 
+
Haz tu artículo fácil de leer, incluye signos de puntuación, una línea en blanco entre párrafos, etc.
+
Incluye títulos y subtítulos para hacer la lectura más cómoda y de mayor accesibilidad a través del índice de la página (tabla de contenidos).
+
 
+
No utilices palabras como Actualmente, ahora, etc, la documentación debe ser atemporal.
+
No crees páginas con el mismo contenido para versiones diferentes de Ubuntu, lo correcto es incluir un apartado en la misma página con la versión de Ubuntu de la que quieras incluir información.
+
  
 
== Enlaces relacionados ==
 
== Enlaces relacionados ==
  
 
Es muy útil para los usuarios incluir una sección de enlaces relacionados con el artículo en cuestión, ya que facilita mucho la navegación. También puedes agregar en otras páginas el enlace a tu artículo en la sección de enlaces relacionados.
 
Es muy útil para los usuarios incluir una sección de enlaces relacionados con el artículo en cuestión, ya que facilita mucho la navegación. También puedes agregar en otras páginas el enlace a tu artículo en la sección de enlaces relacionados.
Por ejemplo, si tu artículo trata sobre mp3, es útil agregar un enlace a [[Formatos Restrictivos]]
+
Por ejemplo, si tu artículo trata sobre mp3, es útil agregar un enlace a [[Formatos Restrictivos]].
  
 
== Si tu artículo no se ajusta a estas convenciones ==
 
== Si tu artículo no se ajusta a estas convenciones ==
Línea 64: Línea 87:
  
 
<!-- Categorías -->
 
<!-- Categorías -->
[[Categoría:Ayuda]]
+
[[Categoría:doc.ubuntu-es]]

Última revisión de 18:52 21 jun 2012

[editar] Manual de estilo

Para que todos los artículos de este sitio mantengan un estilo o formato unificado es necesario establecer ciertas reglas a la hora de la creación de los mismos, facilitando así la lectura y el entendimiento a todos los usuarios y la organización de los contenidos del wiki. Se mencionan aquí ciertos aspectos importantes a la hora de crear páginas o de editar las mismas.

[editar] Escribe en correcto español

  • Aunque puedan establecerse excepciones, se consideran fuentes primarias de referencia las obras de la Asociación de Academias de la Lengua Española.
  • Procura no cometer faltas de ortografía ni gramaticales.
  • Evita en la medida de lo posible los localismos.
  • Exprésate de la forma más simple y clara que puedas.
    • La exposición de un tema debería constar de las siguientes fases: introducción, desarrollo y conclusión.
    • Solo un tema o idea por párrafo.
    • Oraciones cortas, simples y bien estructuradas: sujeto, verbo y complementos.
    • Haz tu artículo fácil de leer, incluye signos de puntuación, una línea en blanco entre párrafos, etc.
  • Evita el lenguaje malsonante.
  • No utilices palabras como Actualmente, ahora, etc.

[editar] Estructura de la página

Siempre que la página tenga más de 3 o 4 párrafos, el artículo deberá estar separado por secciones. Los títulos de las secciones tienen que usar la ortografía general respecto a mayúsculas y minúsculas, es decir, sólo se usarán mayúsculas para las iniciales de los nombres propios y para la primera letra del título. Consulta la sección de secciones en la guía de edición.

El software del wiki crea automáticamente un índice con las secciones llamado TOC. Salvo las razonables excepciones, el TOC debería mostrarse siempre, arriba a la derecha. Puede hacerse fácilmente incluyendo la siguiente marca en la primera línea de la página: <div style="float:right;">__TOC__</div>

Además, siempre que sea posible, deben componerse de texto simple sin formato -negrita o cursiva-, sin enlaces ni imágenes.

[editar] Tú vs usted

El tuteo es un dilema clásico al escribir documentación ¿cómo hemos de tratar al lector? ¿de tú o de usted?

Tuteo

«para instalarlo debes hacer esto y después lo otro.»

De usted

«para instalarlo debe hacer esto y después lo otro.»

Impersonal

«para instalarlo debe hacerse esto y después lo otro.»

En principio, debería usarse un discurso impersonal. También puede ser apropiado el tuteo en guías paso a paso.

[editar] Creación de páginas

Es necesario y muy importante que pensemos bien el título que le vamos a poner a nuestra página antes de crearla. Antes de ello, ten en cuenta estos puntos:

  • Los títulos de las páginas serán también la URL de éstas mismas. Se pueden añadir tildes, pero evita incluir caracteres extraños, pues las URL no los interpretan bien.
  • El título ha de ser completamente específico y evitando información innecesaria. Por ejemplo, si queremos crear una página para el reproductor de música Totem, el título debe ser ese y solo ese, no es necesario llamarla “reproductor de música totem”, puesto que para añadir esa información ya tenemos la categoría Categoría:Reproductores de música.

[editar] Convenciones de nombres

Tanto en los nombres de las páginas como en el modo de escribir, debemos utilizar siempre nombres en español/castellano, por ejemplo, en vez de utilizar términos como "ripear Cd", utiliza "extraer CD".

[editar] Convenciones de marcado de texto

[editar] Líneas de código

Las líneas de código son las líneas donde introducimos por ejemplo comandos para la terminal. Se han de introducir siempre solamente esa línea, no agregues símbolos como $ o # antes del comando, pues esto puede crear confusión a los nuevos usuarios. Por ejemplo:

Bien:

 sudo apt-get update

Mal:

 ~$ sudo apt-get update

[editar] Enlaces

Consulta en Como editar páginas la manera correcta de incluir enlaces, tanto internos (enlaces dentro del mismo wiki) como externos.

[editar] Imágenes

No utilices nunca imágenes superiores a 400x300, pues deformarán el wiki sobre todo a las personas que utilicen una configuración de pantalla pequeña. No utilices imágenes indiscriminadamente. Utiliza solo las imprescindibles o mínimamente necesarias para el entendimiento de la documentación.

[editar] Categorías

Puedes incluir más de una categoría a tu artículo, pero no incluyas en el mismo artículo una categoría y una subcategoría a la vez. Lo correcto es incluir solo la subcategoría más baja, puesto que esto incluirá automáticamente el artículo en la categoría padre.

[editar] Enlaces relacionados

Es muy útil para los usuarios incluir una sección de enlaces relacionados con el artículo en cuestión, ya que facilita mucho la navegación. También puedes agregar en otras páginas el enlace a tu artículo en la sección de enlaces relacionados. Por ejemplo, si tu artículo trata sobre mp3, es útil agregar un enlace a Formatos Restrictivos.

[editar] Si tu artículo no se ajusta a estas convenciones

No te preocupes, otros usuarios podrán adaptarlo. Si no estás seguro de si has dado un estilo o formato adecuado a tu artículo, añade la plantilla Plantilla:wikificar añadiendo el siguiente código al principio de la página:

 {{wikificar}}

Con esto incluirás una nota en tu página para que otros editores del wiki puedan darle un formato adecuado a tu artículo.

Herramientas personales