documentación

Documentación de Software

Proceso de escritura

  1. Planificación
    • Propósito
    • Audiencia
    • Entrega
  2. Investigación
    • Preguntando a expertos
    • Revisando documentación
    • Utilizando el Software
  3. Escritura
    1. Organizar contenido e ideas
    2. Escribir el primer borrador
    3. Repasar y corregir
  4. Revisión/Edición
    • Reorganizar contenido
    • Modificar estilo
    • Corregir gramática y puntuación
    • Incorporar resultados de las pruebas
  5. Lanzamiento
    • Como parte final crear un plan para las actualizaciones

Publicar en WordPress con Asciidoctor

Con este script podemos publicar directamente en nuestro Wordpress a partir de documentos en Asciidoc utilizando Asciidoctor. Para ello sólo tenemos que seguir los siguientes pasos: Descargarnos el fork de blogspot modificado por Dan Allen para que haga la conversión de Asciidoc a HTML utilizando Asciidoctor. Para ello sólo tenemos que clonar su repositorio de github mediante: git clone https://github.com/mojavelinux/asciidoc-blogpost.py.git Instalamos el plugin para conectar Wordpress con Asciidoc: asciidoc --backend install .