Loading presentation...

Present Remotely

Send the link below via email or IM

Copy

Present to your audience

Start remote presentation

  • Invited audience members will follow you as you navigate and present
  • People invited to a presentation do not need a Prezi account
  • This link expires 10 minutes after you close the presentation
  • A maximum of 30 users can follow your presentation
  • Learn more about this feature in our knowledge base article

Do you really want to delete this prezi?

Neither you, nor the coeditors you shared it with will be able to recover it again.

DeleteCancel

Make your likes visible on Facebook?

Connect your Facebook account to Prezi and let your likes appear on your timeline.
You can change this under Settings & Account at any time.

No, thanks

Documentacion tecnica

No description
by

Ricardo Arista Zavala

on 20 August 2014

Comments (0)

Please log in to add your comment.

Report abuse

Transcript of Documentacion tecnica

Es el resultado de un proceso de creación y diseño.
XX%
Coherencia:
Es la unidad y conexión entre las partes y los conceptos manejados en el documento, desarrollando el tema de un modo fácil de seguir.
No hay dejar a un lado el uso de recursos gráficos
Documentación técnica
Documentación técnica
Comunicación efectiva
Comunicación efectiva
Ilustraciones
Existe gran variedad de documentos técnicos
Un buen documento técnico
Precisión:

Se define como la referencia cuidada a la certeza y a los hechos. La precisión en el documento se refiere a la cobertura de los temas con el nivel de detalle adecuado, con el uso cuidadoso del lenguaje.
Son un elemento fundamental para plasmar ideas, transmitir especificar, ejemplificar, ampliar o complementar información, ya sea que se presente de manera independiente y constituya la información en sí misma o que acompañe un texto.

Ayudan a facilitar la comprensión del contenido y deben reforzar el concepto o servir como referencia rápida para aclarar el contenido.
Correo electrónico
Mensajes instantáneos
Oficios
Documentación de software
Presentaciones por computadora
Circulares
Manuales de usuario
Manuales de organización

Es común que en las organizaciones se requiera elaborar ciertos materiales como manuales, guías, cartas, informes o reportes, donde la claridad con que se escribe, el formato que se emplee y la pertinencia en la forma de estructurar el contenido son elementos fundamentales.
La correcta aplicación definirá la eficiencia que tenga al ser consultado por los destinatarios.

Estas reglas no se refieren solamente a aspectos estéticos, sino a reglas precisas y estrictas, para que el material logre su objetivo primordial de presentar información concreta.
Concisión

Es el uso de un mínimo de palabras que expresan la idea básica para solo transmitir el material preciso sin más divagaciones.
Claridad

Se refiere a la facilidad de comprensión y de expresión. Está escrito con oraciones simples y directas.
Hay cinco características siempre presentes:
Seguramente estás familiarizado:
Es preciso seguir una serie de reglas
Es una herramienta clave para organizar y presentar información de manera precisa y en un formato de calidad.
Tecnologías de la Información y la Comunicación
Adecuación:
Es presentar una descripción general del tema al propósito comunicativo.
Páginas web
Apuntes
Libros de texto
Artículos científicos
Guías
Reportes
Instructivos
Para lograr este objetivo el documento debe:

Ser de fácil lectura.
Permitir al lector obtener el mayor provecho de su contenido.
Proporcionar distintos niveles de detalle.
Estructura
Preámbulo:
es la parte inicial del texto con la cual generalmente el lector se da una primera idea del contenido.

Está conformado por varios elementos como: portada, tabla de contenido e introducción.
Aunque sea muy breve, suele tener tres partes:
Contenido:
La

descripción del entorno, el desarrollo y conclusiones.

Referencias:
Los apéndices, fuentes e índices (analítico, tablas, figuras, autoridades, código, etc…).
No es lo mismo un documento impreso que uno electrónico
Medio de distribución
Mapeo de información
Con fragmentos claros y señalamientos adecuados, de tal modo que el lector obtenga con facilidad el beneficio de su contenido.

Este se basa en principios básicos de la comunicación, unidades, etiquetas, bloques, ilustraciones y elementos de tipografía.
Significa convertir el documento en un verdadero mapa
Estos principios (y las reglas para aplicarlos) aseguran un estilo de escritura que satisface las necesidades tanto de los lectores como de los escritores.
El principio de fragmentación

Consiste en organizar la información en unidades pequeñas y manejables.

Una unidad de información manejable consiste en no más de nueve piezas de información (párrafos, ilustraciones, tablas, etc.), colocadas en forma conjunta.

A esto se llama el límite de fragmentación.
El principio de relevancia

Consiste en que los escritores deben asegurarse de que toda la información contenida en un fragmento se refiera a una sola idea basada en su propósito o función para el lector.

Para lograrlo se deben colocar juntas las ideas similares y eliminar de cada fragmento las ideas que no tengan relación entre sí.

El principio de consistencia

Muchas técnicas tradicionales de redacción motivan a los escritores a utilizar la “variedad” para entretener al lector, es decir, el uso de sinónimos.

Sin embargo, al escribir documentos técnicos y de negocios, la calidad se manifiesta en la capacidad del lector para usar el documento en la realización de su trabajo.

Así, en este caso la variedad suele distraer y retardar, en vez de facilitar el trabajo.
El principio de gráficas integradas

Se deben usar diagramas, tablas, ilustraciones, como una parte integral del texto y no como un complemento que se agrega después de terminar de escribir.

Bloque de información
Un
bloque de información
está compuesto de una o más oraciones acerca de un tema determinado.

Su contenido se basa en el propósito y función de la información para el lector.
Reemplazar al párrafo con unidades de información
Tamaño de los bloques
1.- Crear bloques nuevos cuando el bloque contenga más de una idea principal o cuando no toda la información tenga relación directa con la etiqueta.

2.- Insertar subtítulos cuando la información esté relacionada y no se pueda dividir en nuevos bloques.
Existen tres opciones cuando son demasiado extensos
3.- Agregar espacio en blanco cuando no se pueda dividir.
Títulos y etiquetas
El título del mapa debe ser lo más destacado.

Las etiquetas deben ser el segundo elemento más destacado.

Cuando sea posible, el mapa debe quedar en una sola página.

Evitar llenar la página.
Perro
Gato
Documento técnico
Es aquel escrito que contiene información acerca de un área de conocimiento, organizada de forma estructurada y presentada eficazmente a los lectores.

Además cuentan con una estructura en particular y cumplen una serie de principios, de técnicas para “mapear” la información.

Se basa en ciertos procedimientos que permiten presentar la información de forma útil y fácil de consultar.
Tipografía
Es el elemento esencial de todos los documentos, ya sean impresos o electrónicos.

Según su familia, los tipos pueden dividirse en:

Fuentes con patines:
son caracteres que tienen pequeños adornos que facilitan la lectura de las palabras al servir como una especie de guía entre las letras.

Fuentes sin patines:
son caracteres que no tienen adornos.
Full transcript