Diferencia entre revisiones de «Ayuda:Estilo De Notas»

De Dos Ideas.
Saltar a: navegación, buscar
(Nombres de las páginas)
(yVNbmKlPrEDryBnUq)
 
(No se muestran 7 ediciones intermedias de 2 usuarios)
Línea 1: Línea 1:
Para tener una wiki ordenada y prolija, veremos a continuación una serie de convenciones y consejos a la hora de escribir una página wiki en Dos Ideas.
+
Wow! That's a raelly neat answer!
 
 
==Idioma==
 
Preferimos el uso de '''castellano''' en la medida de lo posible. Evitamos el uso de inglés u otros idiomas cuando existen términos y expresiones en castellano de uso habitual.
 
 
 
Usamos la terminología en inglés (u otro idioma) cuando no exista una traducción exacta, o la expresión sea más comunmente usada en su idioma original.
 
 
 
==Estilo de escritura==
 
En la medida de lo posible usamos un estilo impersonal e informal.
 
Configuro el archivo x.properties para... //NO ESCRIBIR ASI
 
Se configura el archivo x.properties...  //PREFERIBLE
 
 
 
==Nombres de las páginas==
 
El nombre de cada página wiki tiene que tener sentido y servir para ubicar el contenido. Ejemplos:
 
Ejemplo De Uso            //NO! No está en claro sobre QUE tema se verá el ejemplo
 
EjemploDeUsoDeFoo        //NO! No "pegar" todas las palabras, usar espacios
 
Ejemplo De Uso De Foo    //OK. Viendo el titulo se sabe qué se encontrará en la página
 
Anotaciones              //Uso general de anotaciones, sin referencia a ninguna tecnología en particular
 
Anotaciones Con Foo      //Queda claro que se verán anotaciones para la tecnología Foo
 
 
 
Usar siempre la primer letra de cada palabra en mayúscula
 
Ejemplo de uso        //NO! Usar la primer letra de cada palabra en mayúscula
 
Ejemplo De Uso        //OK.
 
 
 
En el caso de siglas, usar mayúsculas para todas las letras de la sigla. Por ejemplo:
 
Mensajeria Con MDB
 
Pruebas De EJB
 
Desarrollo Con TDD
 
 
 
Evitar las páginas con nombres de una sola palabra, a menos que se trate de nombres de tecnologías.
 
 
 
==Cantidad de información==
 
Cada página tiene que ser "autocontenida". Es decir, tiene que aportar algo por sí misma.
 
 
 
 
 
== Fin de la nota==
 
Terminamos la nota con dos grupos de links: hacia otros temas de la misma wiki, y hacia recursos externos, en este orden.
 
Todos estos temas se ubican bajo el título de nivel 2 "Ver también". Por ejemplo:
 
 
 
<pre>
 
<nowiki>
 
==Ver también==
 
* [[Una Pagina Wiki Relacionada]]
 
* [[Otra Pagina Wiki Relacionada]]
 
* [http://www.foo.org Web oficial de Foo]
 
* [http://www.foo.org/tutorial Tutorial de Foo]
 
</nowiki>
 
</pre>
 

Revisión actual del 08:20 6 sep 2011

Wow! That's a raelly neat answer!