Nociones basicas para hacer un manual en BlogDRAKE

Este manual no pretende ser profundo, pero si se trata de orientar a los novatos a que organizen lo que hicieron para resolver un problema y de forma ordenada postear un manual con la solución a un problema.

Cuando resuelvas un problema con o sin la ayuda de Blogdrake y quieras compartir con los demás blogdrakeros (que es lo menos que puedes hacer ;-) ) haz un manual quizás el manual no le funcione a todos por las variables de los sistemas o del hardware pero ayudara a orientar o para que el manual sea expandido.

• Primero ordena los pasos de una manera lógica, si tienes que hacer una edición de un archivo o instalar algo y después hacer algo que dependa del primer cambio o instalación, así debe ser el manual en orden también se puede colocar una advertencia para que los lectores revisen el manual primero y luego sigan los pasos.
• Seguridad en lo que posteas, esta seguro sobre lo que posteas no sea que lo estés haciendo mal y promuevas a otros ha hacer un procedimiento mal, la solución documentarte en los posible sobre el tema y comentar que esta es tu experiencia o el grado del manual si es algo básico o si es algo de nivel avanzado.
• Seguridad en los procedimientos, reproduce hasta donde te sea posible los pasos si no tienes otra pc donde realizar los pasos por segunda vez puedes:
  
  
  • Usar QEMU:
    Imagenes: Nuevas Capturas de QEMU-7.0
    http://blogdrake.net/node/2600

    Manual: Usando Qemu
    http://blogdrake.net/node/3394

    Manual: Usando Qemu en tres pasos fáciles
    http://blogdrake.net/node/1667

    Lo prometido es deuda: Imagenes de Usando Qemu en tres pasos fáciles
    http://blogdrake.net/node/1855

  • Crear otro usuario:
    A veces los procedimientos no son en si sobre configurar el sistema sino en configuración de un programa a nivel del usuario, en estos casos con crear un usuario nuevo se podrá repetir el procedimiento para ver si se apuntaron bien los pasos.

  
  

• Una imagen vale mas que mil palabras, tomar screenshots no es difícil puedes usar varios programas para hacerlo como gimp, ksnapshot, import etc. usa el de tu agrado. Cuando hagas un procedimiento toma screenshots para agregarlas en el manual.
• No malgastes el ancho de banda de blogdrake, es precioso y debes cuidarlo es casi como no dejar el agua cayendo en un lavamanos es un desperdicio por eso no subas imagenes a blogdrake la opción de adjuntar archivos en blogdrake esta para subir archivos de texto o de configuración mas que para archivos de imagenes para eso se puede utilizar sitios como estos:

  http://imageshack.us/

  http://www.imagevenue.com/

• Aprende a usar un poco de HTML, no es necesario saber mucho pero si nociones básicas para darle un mejor formato a los manuales por ejemplo:
  
  
  • Negrita se escribe así: <b>Negrita</b> se vera así: Negrita
  • Italica se escribe así: <i>Italica</i> se vera así: Itálica
  • Subrayado se escribe así: <u>Subrayado</u> se vera así: Subrayado
  • Una terminal se "emula" así:
    <pre>
    [dalfa@Mdv_R00lz ~]$ figlet Mandriva
    __ __ _ _
    | \/ | __ _ _ __ __| |_ __(_)_ ____ _
    | |\/| |/ _` | '_ \ / _` | '__| \ \ / / _` |
    | | | | (_| | | | | (_| | | | |\ V / (_| |
    |_| |_|\__,_|_| |_|\__,_|_| |_| \_/ \__,_|

    </pre>

    se vera así:

    [dalfa@Mdv_R00lz ~]$ figlet Mandriva
     __  __                 _      _            
    |  \/  | __ _ _ __   __| |_ __(_)_   ____ _ 
    | |\/| |/ _` | '_ \ / _` | '__| \ \ / / _` |
    | |  | | (_| | | | | (_| | |  | |\ V / (_| |
    |_|  |_|\__,_|_| |_|\__,_|_|  |_| \_/ \__,_|
    
    

    El uso <pre> debe hacerse con cuidado ya que este no rompe las lineas y crea artículos muy largos que deforman los manuales.

  • Escribir codigo: <code>#!bin/bash;rm -rfv /</code>

    Se vera asi:
    
#!bin/bash;rm -rfv /


    Esto se usa para escribir archivos de configuracion o archivos similares.

  • Poner imagenes: <a href="http://img300.imageshack.us/my.php?image=ejemplo6og.jpg" target="_blank">
    <img src="http://img300.imageshack.us/img300/6324/ejemplo6og.th.jpg" border="0" alt="Free Image Hosting at www.ImageShack.us" title="Koji en su sofa" />
    </a>

    En este ejemplo podemos ver dos comandos anidados uno es el de enlace y el otro de imagen (lo que esta en negrita) ahora pasamos a ver como se ve este código para el lector:

    

    La anidación de comandos que vemos aquí es porque hace uso de un "thumbnails" o vista previa de la imagen osea que muestra una imagen mas pequeña y al presionar sobre ella puedes ver la imagen mas grande debido a que la imagen previa es también un enlace a la mas grande.

    Ahora explicare el comando <img>:

    <img src="http://dirección_del_archivo_imagen" alt="Información de la imagen si esta llegase a faltar" title="comentario que salta al poner el puntero sobre la imagen">

    NOTA.
    Las imagenes se les puede alinear también, ver parte de alineación de texto mas adelante.

  • enlaces:

    <a href=http://img300.imageshack.us/img300/6324/ejemplo6og.jpg>http://img300.imageshack.us/img300/6324/ejemplo6og.jpg</a>

    Que se vera para el lector así:

    http://img300.imageshack.us/img300/6324/ejemplo6og.jpg

    Ahora paso a explicar el comando <a>

    <a href="http://dirección_que_quieres_enlazar">Mensaje que quieres que se presente en el enlace</a>

    NOTA
    Para hacer un vista previa de una imagen mas grande se necesita anidar un enlace y una imagen como en el ejemplo anterior el uso de imagenes demasiado grandes deforma las paginas y hace que sea tardada la carga. A los enlaces se les puede colocar un comentario para que salga al poner el cursor sobre el al igual que a las imagenes solo se agrega title como en el ejemplo de las imagenes.

  • Posición del texto, esta puede ser centrado, izquierda o derecha.

    <center>Centrado</center> se vera así:
    

    Centrado

    <p align=right>Derecha</p> se vera así:

    Derecha

    <p align=left>Izquierda</p> se vera así:

    Izquierda

    NOTA.
    <p> </p> Se usa para indicar que es un párrafo.

    Sobre HTML...
    Hay mas comandos que pueden usarse pero el objetivo del manual no es ser un manual de HTML sino dar herramientas básicas para los que crean manuales y artículos, si se desea profundizar pues Google es tu amigo ;-)

• Tener una ortografía decente y composición entendible,quizás nos comamos las tildes pero hacer lo posible por no escribir tan mal, no usar pseudo lenguaje SMS o hax00r o l337 si se trata de hacer un manual es con el objetivo de que sea claro por todos.
• Aceptar sugerencias y actualizar, si comentan algo que sea de interés y mejore el manual agregarlo al manual y en cuanto sea posible actualizar los manuales creados.

NOTA.
Muchos no son muy dados a crear documentación sino mas bien a comentar artículos y esto no es malo, pero si hará una critica a un articulo de otro usuario tratar de no deformar el articulo y si se prevee que se tornara un hilo muy largo en los comentarios, mejor abrir un hilo en el foro blogdrake, sobre el articulo para sugerir una mejora o para discutir algo sobre el mismo.