TechWriter

Generación automática de documentación

TechWriter es una herramienta de análisis de sistemas y documentación que soporta todas las versiones de XBASE. Este producto le ayuda a documentar sus programas y le ahorra tiempo y dinero al automatizar los procesos de recogida, formateo, generación y visualización de la documentación del sistema.

REQUERIMIENTOS:

• CA-Clipper versión Summer '87, 5.01 a 5.3

CARACTERISTICAS:

Con TechWriter, es posible:

• Usar y modificar ficheros de transición de plantillas para controlar cómo se crea la salida
• Producir ficheros Guías Norton/Expert Help, ficheros de ayuda Tom Rettig Help, ficheros WordPerfect o ficheros de texto ASCII. Basta con seleccionar el estilo deseado de una lista. La generación de estos ficheros de ayuda requiere los productos respectivos (por ejemplo, para generar un fichero Guía Norton y Expert Help necesita el producto Expert Help)
• Analizar su código fuente, extraer la documentación que se incluye en bloques de comentario marcados especialmente y producir documentación del sistema en varios formatos opcionales
• Generar documentación del código fuente xBASE en base a las especificaciones de directorio, scripts de enlazado o ficheros de bibliotecas
• Mostrar a sus clientes la evolución hasta la fecha de sus aplicaciones
• Codificar, documentar y optimizar la aplicación continuamente durante el proceso de desarrollo de la aplicación
• Modificar fácilmente la documentación una vez producida
• Documentar tanto bibliotecas como aplicaciones
• Documentar un sistema completo seleccionando el fichero script y los directorios donde se ubica el código fuente
• Capturar pantallas y convertirlas en pantallas de texto de WordPerfect usando las macros de WordPerfect que se incluyen, o capturar cualquier pantalla mostrada en un fichero de texto DOS
• Limitar el número de veces que debe expandirse la misma rama de un árbol de llamadas
• Especificar la interpretación de las tabulaciones en el código fuente
• Usar un editor externo como Brief, MultiEdit o QEdit
• Ejecutar el tutorial incluido para comprobar lo fácil que resulta documentar una aplicación o biblioteca
• Ver el documento usando el programa Expert Help, y comparar la documentación generada con el código utilizado
• Especificar varios directorios y especificaciones de fichero a analizar
• Crear ficheros batch para revisar la evolución de varios sistemas desde un único sitio
• Modificar las reglas de documentación para ajustarlas a sus propios estándares. Esto le permite personalizar la documentación de TechWriter
• Utilizar las rutinas de ejemplo para Clipper 5.x