Unlimited WordPress themes, graphics, videos & courses! Unlimited asset downloads! From $16.50/m
Advertisement
  1. Computer Skills
  2. Documentation
Computers

Cómo Crear un Documento Técnico Profesional-Parte 1

by
Difficulty:IntermediateLength:ShortLanguages:

Spanish (Español) translation by Alfonso Mora (you can also view the original English article)

Un documento técnico es el resultado de la creación de información de usuario técnico eficaz. Tampoco explica cómo funciona algo o cómo usarlo. Puede significar cosas diferentes para personas con diferentes funciones. Puede que necesite dicha documentación a bordo nuevas contrataciones, explicar características nuevas o como referencia para personas no versadas en tecnología.

Escribir un documento técnico necesita una serie de herramientas, una aplicación de captura de pantalla, un editor de imágenes, un procesador de textos para escribir instrucciones y herramientas para compartir el documento.

Aunque este es el mejor protocolo para hacer un documento técnico, no parece correcto cuando falta tiempo o tiene que actualizarlos periódicamente.

En este tutorial de dos partes te mostraré cómo usar Clarify para crear documentos técnicos simples y profesionales.

  • Configurar la aplicación para obtener máximos beneficios.
  • Crear un detallado tutorial con varios pasos, imágenes y texto.
  • Comparte el documento con otras personas o web.

Razones para Elegir Clarify

  1. Clarify es una aplicación multiplataforma disponible para ordenadores Windows y Mac. Es compatible con versiones de Windows Vista al 10 y OS X 10.7 Lion10.11 Capitan y  macOS 10.12 Sierra
  2. Te permite crear documentos técnicos en pequeños pedazos y explicarlos de una manera paso a paso. Puede añadir imágenes, anotar con herramientas visuales y añadir texto para explicar los pasos
  3. Tiene una integración en construcción de herramientas que le permiten compartir el documento a través de web, correo electrónico y evernote. También puede guardar como PDF, HTML y un documento de Word
  4. Le permite crear plantillas HTML y PDF personalizado, para que pueda concentrarse en la tarea de crear un documento técnico y no te preocupes acerca de logos, fuentes, colores, encabezado y pie de página, saltos de página y mucho más

Configuración de Clarify

Clarify da algunas opciones para configurar el documento técnico según sus necesidades. Ir a Clarify > Preferencias.

Verás tres preferencias: General, Compartir y Plantillas PDF. Cada preferencias le permite configurar varios parámetros.

Configuración General

general-settings-clarify-preferences
Seleccione los Ajustes Generales en las Preferencias de Clarify

Configurar los atajos de teclado para la toma de imágenes. Para cambiar las teclas de acceso rápido, haga clic en Quitar y escriba en la nueva tecla de acceso rápido. Si lo prefiere gran lienzo para escribir sus documentos técnicos, cambiar Editor Tamaño del Texto Editor del Documento de Pequeño a Grande.

Clarify permite que es personalizar los ajustes de imagen, la forma que desee. Seleccione el formato de exportación como PNG o JPEG (Bueno, Mejor, Excelente). Puede generar automáticamente etiquetas ALT para las imágenes o escalar automáticamente las imágenes, anchura y altura, según la guía de estilo.

Compartir

share-settings-clarify-preferences
Elija Configuración de compartir en preferencias de Clarify. Haga clic en botón + para añadir una cuenta

Clarify ofrece un número de diferentes maneras de compartir los documentos creados. Puede exportar a clarify it.com así otros pueden ver documentos. Puede exportar el documento al blog de WordPress personalizado o .com blog o guardar como PDF, HTML o un documento de Word.

Plantillas en PDF

Clarify viene con cuatro plantillas básicas: Basic, blanco y negro, cromo y corporativo.

Si tienes algunas necesidades específicas puede crear su propia plantilla PDF. Haga clic en el botón + para crear una nueva plantilla personalizada.

customize-general-settings-pdf-template
Personalizar la configuración general de una plantilla PDF. Haga clic en el botón + para añadir una plantilla personalizada

En la ficha General, personalizar el tamaño de página y márgenes, alineación de la imagen, configuración de contenido de flujo y más. Al generar un documento PDF, Clarify agrega roturas de página en algunos lugares. Aunque Clarify intenta mantener paso contenido juntos, puede configurarlos.

Haga clic en el menú de Flujo de Contenido de para configurar los parámetros de rotura de página. Elegir un Paso por página para agregar un salto de página después de cada paso.

Elija Ajuste Contenido Como sea Posible por Página para poner tanto contenido en la página como sea posible. Usar CSS para más control sobre saltos de página.

En el campo de encabezado puede Agregar un Logo y personalizar algunas variables más. Usted puede Añadir Variables como

  • [[Document Title]] — El nombre del documento
  • [[File_Name]] — El nombre del archivo PDF
  • [[Date]], La fecha en el formato que utilice su sistema
  • [[MM/DD/AAAA]], Mes, día y año

En el campo de pie de página puede Agregar texto de número y pie de página. Usted puede añadir variables como

  • [[Page_Number]] — El número de página
  • [[Page_Count]] — El número total de páginas
customize-fonts-colours-pdf-template
Personalizar fuentes y colores de la plantilla PDF

En la pestaña Fuentes y Colores, fuente del sistema predeterminada, tamaño de fuente y color para el encabezado y pie de página, Descripción del artículo, título de paso y substep título. Si no define una fuente para un objeto determinado, entonces usará la Fuente por Defecto.

customize-css-pdf-template-clarify
Personalizar el CSS de una plantilla PDF. Tener un conocimiento de CSS le permite añadir muchas variables

La pestaña Custom CSS le permite hacer ajustes a los elementos que no están disponibles en la interfaz de usuario. Plantillas en PDF en el Clarify funciona bajo el principio de HTML y CSS. Si tienes un conocimiento de ambos, puede Agregar muchas variables a plantilla PDF. Por ejemplo

.step-container (
page-break-after: always
)

Este CSS dice el generador PDF para agregar siempre un salto de página después de un paso. También puede Agregar fuente específica estilo a su documento PDF mediante la adición de clases específicas de CSS en el documento.

.step-title (
font-style: italic;
font-weight: lighter;
)

Algunas de las clases que puede utilizar son article-description,step-titlestep-containersub-step, Y step-instructions. En cada paso puede hacer clic en Vista Previa para ver el resultado final de la plantilla PDF.

Conclusión

Clarify es una aplicación nativa para Windows y Mac crear documentos técnicos. Le permite crear plantillas para que pueda concentrarse en crear un documento técnico sin aspavientos y gestionar múltiples aplicaciones: herramienta de captura, procesador de textos y herramientas decompartir.

En este tutorial, he mostrado cómo configurar app Clarify para cosechar los máximos beneficios y cómo configurar plantillas.

En el siguiente tutorial, te voy a dar un procedimiento paso a paso para la creación de un documento técnico. La aplicación incluye una prueba de 14 días y está disponible por $29.99. Ver los Detalles de Precios para obtener más información.

Advertisement
Advertisement
Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.