La documentación es cualquier material comunicable que se utiliza para describir, explicar o instruir sobre algunos atributos de un objeto, sistema o procedimiento, como sus piezas, montaje, instalación, mantenimiento y uso. [1] Como forma de gestión y organización del conocimiento , la documentación puede proporcionarse en papel, en línea o en medios digitales o analógicos , como cintas de audio o CD . Algunos ejemplos son guías de usuario , documentos técnicos , ayuda en línea y guías de referencia rápida. La documentación en papel o impresa se ha vuelto menos común. [ cita necesaria ] La documentación a menudo se distribuye a través de sitios web, productos de software y otras aplicaciones en línea.
La documentación como conjunto de materiales didácticos no debe confundirse con la ciencia de la documentación , el estudio del registro y recuperación de información.
Si bien las normas asociadas de la Organización Internacional de Normalización (ISO) no están fácilmente disponibles públicamente, una guía de otras fuentes para este tema puede servir para este propósito. [2] [3] [4] [5]
El desarrollo de la documentación puede implicar la redacción, el formato, el envío, la revisión, la aprobación, la distribución, la publicación y el seguimiento del documento, etc., y están convocados por un procedimiento operativo estándar asociado en una industria regulatoria. También podría implicar la creación de contenido desde cero. La documentación debe ser fácil de leer y comprender. Si es demasiado largo y con demasiadas palabras, es posible que se malinterprete o se ignore. Se deben utilizar palabras claras y concisas y las frases deben limitarse a un máximo de 15 palabras. La documentación destinada a un público general debe evitar términos específicos de género y prejuicios culturales. En una serie de procedimientos, los pasos deben estar claramente numerados. [6] [7] [8] [9]
Los redactores técnicos y comunicadores corporativos son profesionales cuyo campo y trabajo es la documentación. Lo ideal es que los redactores técnicos tengan experiencia tanto en la materia como en redacción, gestión de contenidos y arquitectura de la información . Los redactores técnicos suelen colaborar con expertos en la materia , como ingenieros, expertos técnicos, profesionales médicos, etc., para definir y luego crear documentación que satisfaga las necesidades del usuario. Las comunicaciones corporativas incluyen otro tipo de documentación escrita, por ejemplo:
Los siguientes son tipos típicos de documentación de software:
Los siguientes son tipos típicos de documentación de servicio y hardware:
Un tipo común de documento de software escrito en la industria de la simulación es el SDF. Al desarrollar software para un simulador, que puede variar desde dispositivos de aviónica integrados hasta bases de datos de terreno 3D pasando por sistemas completos de control de movimiento, el ingeniero lleva un cuaderno que detalla el desarrollo "la construcción" del proyecto o módulo. El documento puede ser una página wiki, un documento de Microsoft Word u otro entorno. Deben contener una sección de requisitos , una sección de interfaz para detallar la interfaz de comunicación del software. A menudo se utiliza una sección de notas para detallar la prueba de concepto y luego realizar un seguimiento de los errores y las mejoras. Finalmente, una sección de prueba para documentar cómo se probó el software. Esto documenta la conformidad con los requisitos del cliente. El resultado es una descripción detallada de cómo está diseñado el software, cómo crearlo e instalarlo en el dispositivo de destino y cualquier defecto y solución alternativa conocidos. Este documento de compilación permite a los futuros desarrolladores y mantenedores ponerse al día con el software de manera oportuna y también proporciona una hoja de ruta para modificar el código o buscar errores.
Estas herramientas de software pueden recopilar automáticamente datos de su equipo de red. Los datos podrían ser para inventario y para información de configuración. La Biblioteca de Infraestructura de Tecnología de la Información solicita la creación de una base de datos de este tipo como base para toda la información para el responsable de TI. También es la base para la documentación informática. Los ejemplos incluyen la configuración XIA. [11]
"Documentación" es el término preferido para el proceso de completar bases de datos criminales. Los ejemplos incluyen el entorno de datos de identidades terroristas del Centro Nacional Contra el Terrorismo , los registros de delincuentes sexuales y las bases de datos de pandillas. [12]
La documentación, en lo que respecta al campo de la educación infantil, es "cuando notamos y valoramos las ideas, pensamientos, preguntas y teorías de los niños sobre el mundo y luego recopilamos rastros de su trabajo (dibujos, fotografías de los niños en acción y transcripciones). de sus palabras) para compartir con una comunidad más amplia". [13]
Así, la documentación es un proceso, utilizado para vincular el conocimiento y aprendizaje del educador del niño/s con las familias, otros colaboradores e incluso con los propios niños.
La documentación es una parte integral del ciclo de indagación: observar, reflexionar, documentar, compartir y responder. [13]
La documentación pedagógica, en el sentido de la documentación del profesor, es la "historia del profesor sobre el movimiento en la comprensión de los niños". [13] Según Stephanie Cox Suarez en "Documentación - Transformando nuestras perspectivas", "los profesores son considerados investigadores, y la documentación es una herramienta de investigación para apoyar la construcción de conocimientos entre niños y adultos". [14]
La documentación puede adoptar muchos estilos diferentes en el aula. A continuación se ejemplifican formas en que la documentación puede hacer visible la investigación o el aprendizaje:
La documentación es ciertamente un proceso en sí mismo, y también es un proceso dentro del educador. El siguiente es el desarrollo de la documentación a medida que avanza para y en el propio educador:
{{cite book}}: Mantenimiento CS1: falta el editor de la ubicación ( enlace )