Documentacin Tcnica

La documentacin de sistemas es el conjunto de informacin que nos dice qu

hacen los sistemas, cmo lo hacen y para quin lo hacen.
Un documento tcnico es aquel escrito que contiene informacin acerca de un
rea de conocimiento, organizada de forma estructurada y presentada
eficazmente a los lectores. De manera muy sencilla podemos definir un
documento tcnico como todo aquel documento que no es una obra literaria y
que est relacionado con el mbito laboral, tecnolgico o cientfico.
Muchas organizaciones tienen lo que se conoce como un "programa de
documentacin", el cual consiste en una poltica formal cuya documentacin
se muestra como algo que debe prepararse en forma rutinaria para cada
programa de cmputo, archivo y nuevos sistemas.

Propsitos
La documentacin tcnica es uno de los pilares de nuestra civilizacin. La
forma en que la mayora de nosotros podemos beneficiarnos con los
descubrimientos y avances es preservarlos de forma escrita, ya sea impresa en
los tradicionales libros y revistas o de manera electrnica.
La
documentacin
consiste
en
material
que
explica
las
caractersticas tcnicas y la operacin de un sistema. Es esencial para
proporcionar entendimiento de un sistema a quien lo vaya a usar para
mantenerlo, para permitir auditoria del sistema y para ensear a los usuarios
como interactuar con el sistema y a los operandos como hacerlo funcionar.

Caractersticas
Para escribir un buen documento tcnico es preciso seguir una serie de reglas,
cuya correcta aplicacin definir la eficiencia que tenga al ser consultado por
los destinatarios. Estas reglas no se refieren solamente a aspectos estticos o
de inspiracin del escritor, sino a reglas precisas y estrictas, que sin dejar a un
lado un aspecto agradable a la vista o una organizacin y uso de recursos
grficos, el material logre su propsito primordial de presentar informacin
concreta.

Tipos de documentos tcnicos

instructivo, apuntes, guas, etc.).

(texto,

reporte,

manual,

Existe gran variedad de documentos tcnicos, con los cuales seguramente

ests familiarizado:

Correo electrnico
Mensajes instantneos
Oficios
Documentos de software
Presentaciones para computadora
Circulares
Manuales de usuario
Manuales de organizacin
Paginas web
Apuntes
Libros de texto
Artculos cientficos
Guas
Reportes
Instructivos

Tipos de documentos por su forma de distribucin

Es indispensable considerar la forma en que el documento se har llegar a los
lectores. No es lo mismo un documento impreso que un documento
electrnico. Ser distinto si se enva en original que si se sacan fotocopias, si
se presenta a travs de un proyector o se ve directamente del monitor.
Todo esto ser fundamental para definir el contenido, la tipografa y el diseo
del documento.
En general, se tienen tres grandes medios de distribucin:
Documentos impresos
Documentos electrnicos
Documentos para presentacin en pantalla
Los documentos impresos se conservan en algn tipo de papel. Entre ellos
tenemos hojas sueltas, cuadernos, engargolados, libros, etc. Este tipo de
documentos parece tender a disminuir puesto que su elaboracin resulta ms
cara y laboriosa que los documentos electrnicos. Sin embargo, cierta
informacin requiere estar impresa para ser fcil de manejar y/o confiable. Por
ejemplo: facturas, libros, cartas, revistas, etctera.
Los documentos electrnicos tienen cada vez mayor auge, ya que se
distribuyen rpidamente y ahorran papel. Entre ellos tenemos el correo
electrnico y archivos en formato Word o pdf, pginas web, entre otros.
Los documentos para presentaciones tienen el objetivo de mostrar de manera
simultnea a varias personas cierta informacin. Estos documentos se apoyan
de proyector, acetatos, diapositivas, etctera.