diff --git a/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.dia b/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.dia new file mode 100644 index 0000000..ce4cf69 Binary files /dev/null and b/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.dia differ diff --git a/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.dia~ b/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.dia~ new file mode 100644 index 0000000..ce4cf69 Binary files /dev/null and b/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.dia~ differ diff --git a/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.png b/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.png new file mode 100644 index 0000000..1a200bd Binary files /dev/null and b/1/ISO/assignments/t9-ej1-documento-tecnico/cmap-documento-tecnico.png differ diff --git a/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.pdf b/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.pdf new file mode 100644 index 0000000..1453429 Binary files /dev/null and b/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.pdf differ diff --git a/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.tex b/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.tex new file mode 100644 index 0000000..4bf0b10 --- /dev/null +++ b/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.tex @@ -0,0 +1,150 @@ +\documentclass[12pt,a4paper]{article} +\usepackage[spanish]{babel} +\usepackage{hyperref} +\usepackage{graphicx} +\usepackage{subcaption} + +\title{Tema IX Ejercicio I: Los Documentos Técnicos} +\author{Nicolás A. Ortega Froysa} + +\begin{document} +\maketitle +\pagebreak +\tableofcontents +\pagebreak + +\section{Mapa Conceptual} +\begin{figure}[!htb] + \centering + \includegraphics[width=1.0\linewidth]{./cmap-documento-tecnico.png} + \caption{Mapa conceptual de documentación técnica.} + \label{fig:mapa-conceptual} +\end{figure} + +\section{¿Qué Es Un Documento Técnico?} + +Podemos decir que un {\em documento técnico} es un informe profundo que nos +aporta soluciones a algún problema, o nos explica cómo hacer alguna tarea +técnica. A su vez, nos explica cómo hacerlo con una autoridad educativa, con un +lenguaje claro y conciso (i.e.\ sin ambigüedades). + +\section{¿Cómo Se Elabora?} + +El proceso de elaborar un documento técnico es, en realidad, bastante fácil e +intuitivo. Se trata de hacer un documento que sea explicativo y facilite la +comprensión del lector. Para elaborar un documento técnico, generalmente +queremos seguir tres pasos: + +\begin{enumerate} + \item Ideación + \item Preparación + \item Escritura +\end{enumerate} + +\subsection{Ideación} + +El documento que escribimos ha de tener un fin concreto, así que hemos de +decidir cuál es el tema que estamos intentando explicar. Se tiene que saber cuál +es el {\em problema} que se va a tratar y cuál es su {\em solución}. Sin éstos +dos no hay sentido en hacer documento. + +También es necesario tomar en cuenta la {\em audiencia} a la que se refiere; o +lo mismo que decir, quiénes son los (futuros) lectores de este documento. El +documento ha de ser adaptado a sus necesidades y conocimientos. + +Por último, el documento ha de tener {\em pericia}, manteniéndose bien dentro de +lo que sería su área de especialización, saliéndose de ésta tan sólo si es +absolutamente necesario. + +\subsection{Preparación} + +Antes de crear ningún documento, es necesario preparar todos los materiales, las +fuentes, y demás que serán necesarios para la elaboración de este documento. +Para esto, en primer lugar, se ha de hacer una {\em investigación} inicial. Esta +investigación es también importante para aportar legitimidad al documento +técnico, al citar las fuentes usadas. Esto es especialmente importante cuando se +cita cualquier dato que no sea de conocimiento popular del lector. + +Es preciso la elaboración de una esquema que ayudará a organizar nuestras +propias ideas y el proceso de escritura. Ésta ha de tener, como mínimo, los +siguientes apartados: + +\begin{itemize} + \item Título + \item Resumen Ejecutivo: breve resumen del tema + \item Introducción + \item Secciones + \item Subsecciones + \item Barras Laterales: notas adiciones que se quieren añadir + \item Conclusión +\end{itemize} + +\subsection{Escritura} + +Ya sí a la hora de escribir, es todavía importante tomar en cuenta ciertas +prácticas de escritura que caracterizan los documentos técnicos. + +En primer lugar, se tiene que {\em ceñir en los hechos}: es decir, no se ha de +aportar opiniones o evaluaciones subjetivas, sino enfocarse en aquello que es +objetivo. A falta de esto, se convierte en un ensayo, no un documento técnico. + +Siempre se ha de {\em citar las fuentes} de cualquier dato que se use en el +documento. A falta de esto, quita credibilidad al documento y es pecado de +plagio. + +Es importante el uso de un {\em tono profesional}, ya que se trata de un +documento que seguramente se leerá en un ambiente profesional. Aunque pueda ser +muy gracioso meter unos comentarios sarcásticos o irónicos, no ayuda a la +comprensión del texto y generalmente distrae. + +Ha de tener una {\em introducción fuerte} que transmite con claridad al lector +qué pueden esperar del documento. Esto se hace simplemente con mencionar cuál es +el problema que aborda el documento y cómo se va a resolver. No es necesario +entrar en detalle. + +Finalmente, el documento ha de pasar por un {\em proceso de edición}. Muchas +veces cuando escribimos cometemos errores, o paramos unos momentos y volvemos, +perdiendo de vista cuál era el sentido de lo que escribimos. Entre una cosa y +otra se escriben a menudo unos documentos que tienen poco sentido y son +difíciles de entender. Por esto es importante tener un proceso de edición al +finalizar la escritura. + +\section{¿Cómo Se Ha De Formatear?} + +Un documento técnico tiene un formato característico. Es un documento, +generalmente, {\em largo}, extendiéndose hasta más de 6 páginas -- o incluso más +de 50. También ha de ser un {\em documento estructurado}, como vimos antes con +el esquema. Si tiene falta de estructura, será desorganizada y causará confusión +al lector. Por su naturaleza, también será un documento {\em denso} en +contenido. Finalmente, se caracteriza por su {\em diseño}, que generalmente +tiene los siguientes elementos: + +\begin{itemize} + \item Portada captadora + \item Resalte de datos y citas importantes + \item Uso inteligente del espacio blanco + \item Datos visualizados (gráficas) + \item Variedad de estilos + \item Columnas de texto para separación de secciones + \item Elementos visuales alineados + \item Marca incorporada +\end{itemize} + +\section{Conclusión} + +Realmente la elaboración de un documento técnico no es algo difícil, sino que +realmente es bastante fácil e intuitivo, especialmente para aquellas personas +que los usan diariamente. Simplemente se tiene que transmitir los hechos y datos +de la manera más objetiva, clara, y concisa posible. + +\pagebreak + +\section{Derechos de Autor y Licencia} + +\noindent +Copyright \copyright\ \the\year\ Nicolás A. Ortega Froysa +\\ +Este documento se distribuye bajo los términos y condiciones de la licencia +Creative Commons Attribution No Derivatives 4.0 International. + +\end{document} diff --git a/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.toc b/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.toc new file mode 100644 index 0000000..635096a --- /dev/null +++ b/1/ISO/assignments/t9-ej1-documento-tecnico/t9-ej1-documento-tecnico-naortega.toc @@ -0,0 +1,10 @@ +\babel@toc {spanish}{}\relax +\contentsline {section}{\numberline {1}Mapa Conceptual}{3}{section.1}% +\contentsline {section}{\numberline {2}¿Qué Es Un Documento Técnico?}{3}{section.2}% +\contentsline {section}{\numberline {3}¿Cómo Se Elabora?}{3}{section.3}% +\contentsline {subsection}{\numberline {3.1}Ideación}{4}{subsection.3.1}% +\contentsline {subsection}{\numberline {3.2}Preparación}{4}{subsection.3.2}% +\contentsline {subsection}{\numberline {3.3}Escritura}{5}{subsection.3.3}% +\contentsline {section}{\numberline {4}¿Cómo Se Ha De Formatear?}{5}{section.4}% +\contentsline {section}{\numberline {5}Conclusión}{6}{section.5}% +\contentsline {section}{\numberline {6}Derechos de Autor y Licencia}{7}{section.6}%