A lo largo de la realización de un proyecto, se genera diferente documentación técnica.

• Internamente, la documentación técnica se utiliza para dar a conocer a los miembros de un equipo los distintos procesos de trabajo, los plazos, las condiciones de entrega, las directrices internas, etc. También permite guardar el saber hacer de una compañía en los documentos de los proyectos técnicos.

• Externamente, la documentación técnica sirve para dar a conocer un producto determinado a un público objetivo, mediante manuales de usuario, tutoriales, guías de resolución de problemas, etc.

Elaboración
La documentación técnica no es una obra literaria sino un conjunto de documentos que deben ser claros y precisos para cumplir la finalidad prevista.
A la hora de elaborar la documentación de tus proyectos, ten en cuenta las siguientes indicaciones:

• Estructura los contenidos mediante títulos y subtítulos que ayuden a la comprensión.
• Cada párrafo debe hacer referencia a una única idea. Procura no mezclar ideas o conceptos en un solo párrafo.
• Escribe sólo lo necesario, usando frases cortas y evitando descripciones extensas o demasiado detalladas.
• Utiliza gráficos y tablas. El lenguaje visual evita explicaciones larguísimas que pueden aburrir al lector o dificultar la comprensión del documento.
• Numera las imágenes y las figuras que aparezcan en el documento.
• Usa el estilo formal y evita las redundancias, las cacofonías y el uso de palabras coloquiales.
• Utiliza los signos de puntuación adecuados.
• Si usas abreviaturas, explícalas la primera vez que aparezcan en el texto.
• Elige una tipografía que aporte a tu documento un aspecto profesional. No te quedes con la tipografía que te ofrezca por defecto tu procesador de texto.

Presentación y difusión
Cuando se termina de desarrollar un proyecto, es necesario difundirlo entre los agentes implicados. Se pueden realizar actividades de presentación, para que los posibles clientes lo conozcan, o publicitarlo o difundirlo si se busca su comercialización, para hacérselo llegar al público en general.

Presentar un proyecto no consiste en ofrecer a los clientes la documentación técnica que se ha generado durante su producción, sino que se realizan otras actividades, como eventos, seminarios, conferencias, etc., mediante las cuales se muestra el proyecto de una forma atractiva para que genere interés en la audiencia.

Para que una presentación tenga más probabilidades de éxito, es necesario prestar atención a:

• Los objetivos. No es lo mismo presentar un producto muy novedoso con muchas posibilidades de éxito que un producto de colaboración que requiera financiación externa. Tener claro a qué objetivos se dirige la presentación permitirá decidir el diseño, el estilo y el tono de la presentación.

• La audiencia. No es necesario conocer a cada una de las personas, pero tener una percepción general sobre el grupo ayudará a saber si el producto que se va a dar a conocer será apropiado para esas personas o no y adaptar la terminología de la presentación al contexto.

• El entorno. La presentación será diferente si se va a hacer en un entorno virtual, en el que son necesarios medios tecnológicos de calidad que ofrezcan condiciones adecuadas de imagen y de sonido, o bien en un entorno presencial, en el que se debe prestar atención a otros factores, como las dimensiones del recinto (que incidirán en que la presentación sea más o menos cercana al público), el mobiliario existente (que impedirá o facilitará los movimientos), la iluminación, etc.

• Las herramientas digitales utilizadas. En la actualidad disponemos de muchas herramientas distintas para hacer presentaciones de productos. Se deben escoger aquellas que aporten dinamismo y modernidad. Las más tradicionales, como PowerPoint o Impress, pueden hacer que un producto parezca obsoleto.

• El tiempo. El control de los tiempos en una presentación debe ser riguroso para ajustarse a la duración planteada. Exceder los tiempos previstos suele considerarse una falta de respeto a la audiencia.

Las actividades de difusión de un producto o proyecto están muy ligadas al uso de herramientas tecnológicas y de Internet: se crean anuncios para los medios tradicionales (prensa, radio, televisión...), se elaboran webs y se utilizan las redes sociales.
Si quieres crear una web para difundir tu proyecto tendrás que cuidar su diseño y tener en cuenta ciertas consideraciones para que la página aparezca en las primeras posiciones cuando un cliente potencial haga una búsqueda en Internet.

Estos consejos te pueden ayudar a conseguirlo:

• Crea una estructura sencilla para la web. El menú debe ser simple e intuitivo. Piensa en la sencillez también a la hora de elegir colores, tamaños de letra, etc.
• Selecciona bien las palabras clave. Escoge aquellas que mejor definan tu proyecto. Con ello facilitarás que el usuario localice antes lo que está buscando.
• Cuida los contenidos. No copies de otras fuentes: utiliza textos originales, redactados por ti de forma que resulten claros. Incluye también imágenes de buena calidad, de no mucho peso (para no ralentizar la navegación) y correctamente etiquetadas.
• Incluye un blog. En él podrás detallar tu proyecto con precisión, incluir enlaces a su documentación, incluir nuevas informaciones, etc

Profundiza:

¿Qué es el posicionamiento SEO?
SEO (search engine optimisation) es una práctica mediante la que se prepara el contenido que se quiere mostrar en Internet para que sea fácilmente localizable por los buscadores más conocidos.

Ver video