Cómo crear un artículo

De Sistemas
Saltar a: navegación, buscar

Contenido

Libro de estilo

Para conseguir una uniformidad en la documentación y facilitar la edición es fundamental seguir una serie de normas de estilo que desarrollaremos entre todos en este artículo.

Una forma sencilla de mantener dicha uniformidad es a mediante plantillas.

Nomenclatura de los artículos

Los nombres de los artículos siguen la siguientes reglas:
La primera letra en mayúscula el resto en minúscula salvo que por norma vaya en mayúscula
Con espacio entre las palabras (en el wiki usaremos el guión bajo '_')
Las tildes correspondientes
Sintaxis de los artículos
Desde la URL poner detras de la última barra el nombre del artículo que queremos crear:

http://es.wikipedia.org/wiki/nombre del artículo

Se utilizarán los guines bajos para los espacios en blanco.
El nombre que se ponga en la URL será el nombre del artículo
Se deberá seguir las normas,sintaxis y ortografía de la Real Academia de la Lengua

Nomenclatura de imágenes

Los prefijos irán en mayúsculas siguiendo esta regla:
Para procedimientos .... PRO + nombre del archivo
Para manuales .... MAN + nombre del archivo
Para videos .... VID + nombre del video
Para planos .... PLA + nombre del plano
Para señalítica ....SEN + nombre del cartel
Para logos .... LOG + nombre descriptivo
Para las fotos ... FOT + nombre descriptivo
Para lo que no sea calificable .... XXX + nombre del archivo
El nombre del archivo deberá ser descriptivo de la imagen para evitar posibles solapamientos con otros.
Si hay mas de una imagen del mismo tema como sufijo se pondrá 1, 2, 3, etc según el orden en el que vayan.

Nomenclatura de las categorías

Primera letra en mayúscula y el resto en minúcula salvo que por norma sea con mayúcula
Tiene que ser descriptiva para que con solo verla se sepa que tipo de artículos van incluidos en ella.
Sintaxis de la categoría
Dentro del recuadro de texto se pone:
Category:nombre de la categoría todo ello encerrado entre corchetes dobles

Tipos de artículos

Procedimientos

Los procedimientos a crear se podrian dividir en dos, los dedicados a hardware y otro a software
Procedimiento de Software
Deberá dividirse en:
1. Introducción explicativa sobre el cometido de la aplicacion, el ámbito en el que se usa(departamental, alumnos, etc)
2. INSTALACIÓN: Explicación de los pasos a dar para su instalación a ser posible con pantallazos para que quede mas claro
3. CONFIGURACÓN: Explicacion de la configuracion, si hay diferentes tipos de configuracion según el uso también
4. COMPROBACIÖN: apartado en el que se indicará como comprobar que funciona correctamente
COMO EJEMPLO Artículo Antivirus
Procedimiento de Hardware
Deberá contener:
1. Introducción
2. Especificaciones
Nota: Es necesario revisar esta página.
Manuales
Los manuales son una explicacion mas extensa y completa que la de un procedimiento por lo que habrá dos partes:
1. Una introduccion para que la persona que lo lea sepa si es lo que necesita
2. Enlace externo que lleve al Manual


Herramientas para la edición

La sintaxis que se utiliza en wiki puede resultar compleja, especialmente si no se utiliza a menudo. Existen herramientas que ayudan a crear el artículo.

Toolbars

Conversores de tablas

Ver mas

Para ver con mas claridad la estructura de un procedimiento pincha en este ESQUEMA.

Cómo crear un artículo

Ayuda
Subir imágenes
Subir multimedia
Uso de tablas
Uso de plantillas

Trucos

Hay varias formas de ver qué artículos crear:
1. De los repositorios que tenemos, DMS e y:\Documentacion\Procedimientos id wikificando y moviendo a la carpeta wikificado para denotar que ya está wikificado.
2. Con la página Paginas Requeridas veremos una lista de lo que ya está referenciado en algún artículo pero no se ha creado el artículo.
3. Con el día a día.
4. En algunos casos puede resultar interesante colgar un video demostrativo realizado con Wink

Notas

A la hora de nombrar los programas instalados en los Pc´s no pondremos la versión puesto que al ser algo general el año que viene puede haber otra versión y tocaria cambiarlo.
Herramientas personales