Documentación

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 partes, ensamblaje, instalación, mantenimiento y uso. ^[1] Como una forma de gestión del conocimiento y organización del conocimiento , la documentación se puede proporcionar en papel, en línea o en medios digitales o analógicos , como cintas de audio o CD . Algunos ejemplos son las guías de usuario , los libros blancos , la ayuda en línea y las guías de referencia rápida. La documentación en papel o en papel se ha vuelto menos común. ^{[ cita requerida ]} 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 de instrucción 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 ser útil. ^{[2] [3] [4] [5]}

El desarrollo de la documentación puede implicar la redacción, el formato, la presentación, la revisión, la aprobación, la distribución, la reimpresión y el seguimiento de los documentos, etc., y se lleva a cabo mediante un procedimiento operativo estándar asociado en una industria regulatoria. También puede implicar la creación de contenido desde cero. La documentación debe ser fácil de leer y comprender. Si es demasiado larga y con demasiadas palabras, puede ser malinterpretada o ignorada. Se deben utilizar palabras claras y concisas, y las oraciones 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 sesgos 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 otros tipos de documentación escrita, por ejemplo:

• Comunicaciones de mercado (MarCom): los redactores de MarCom se esfuerzan por transmitir la propuesta de valor de la empresa a través de una variedad de medios impresos, electrónicos y sociales. Esta área de la redacción corporativa suele involucrarse en la respuesta a propuestas.
• Comunicación técnica (TechCom): los redactores técnicos documentan el producto o servicio de una empresa. Las publicaciones técnicas pueden incluir guías de usuario, manuales de instalación y configuración, y procedimientos de reparación y resolución de problemas.
• Redacción legal : este tipo de documentación suele ser preparada por abogados o asistentes legales.
• Documentación de cumplimiento: Este tipo de documentación codifica los procedimientos operativos estándar, para cualquier necesidad de cumplimiento normativo, como aprobación de seguridad, impuestos, financiación y aprobación técnica.
• Documentación sanitaria: Este campo de la documentación abarca el registro y la validación oportunos de los eventos que han ocurrido durante el curso de la prestación de la atención sanitaria. ^[10]

Los siguientes son tipos típicos de documentación de software:

• Solicitud de propuesta
• Requisitos / declaración de trabajo / alcance del trabajo
• Diseño de software y especificación funcional
• Diseño del sistema y especificaciones funcionales
• Gestión de cambios , seguimiento de errores y mejoras
• Prueba de aceptación del usuario
• Páginas de manual

Los siguientes son tipos típicos de documentación de hardware y servicio:

• Diagramas de red
• Mapas de red
• Hoja de datos para sistemas TI ( servidor , conmutador , etc.)
• Catálogo de servicios y portafolio de servicios ( Biblioteca de Infraestructura de Tecnologías de la Información )

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 abarcar desde dispositivos de aviónica integrados hasta bases de datos de terreno en 3D pasando por sistemas de control de movimiento completos, el ingeniero lleva un cuaderno en el que se 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 hacer un seguimiento de los errores y las mejoras. Por último, una sección de pruebas 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 construir e instalar el software en el dispositivo de destino y cualquier defecto conocido y solución alternativa. Este documento de construcció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 pueden 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 de TI. Algunos ejemplos incluyen XIA Configuration. ^[11]

"Documentación" es el término preferido para el proceso de llenar bases de datos criminales. Algunos ejemplos incluyen el Terrorist Identities Datamart Environment 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 de la primera infancia, es "cuando observamos y valoramos las ideas, el pensamiento, las preguntas y las 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 que se utiliza para vincular el conocimiento y el aprendizaje del educador sobre el niño/los niños con las familias, otros colaboradores e incluso con los propios niños.

La documentación es una parte integral del ciclo de investigación: observar, reflexionar, documentar, compartir y responder. ^[13]

La documentación pedagógica, en términos de la documentación docente, es la “historia del maestro sobre el movimiento en la comprensión de los niños”. ^[13] Según Stephanie Cox Suárez en “Documentación – Transformando nuestras perspectivas”, “los maestros son considerados investigadores, y la documentación es una herramienta de investigación para apoyar la construcción de conocimiento entre niños y adultos”. ^[14]

La documentación puede adoptar muchos estilos diferentes en el aula. A continuación se muestran algunos ejemplos de formas en las que la documentación puede hacer visible la investigación o el aprendizaje:

1. Paneles de documentación (presentación tipo tablón de anuncios con múltiples imágenes y descripciones sobre el proyecto o evento).
2. Registro diario (un registro que se lleva todos los días y que registra el juego y el aprendizaje en el aula)
3. Documentación desarrollada por o con los niños (al observar a los niños durante la documentación, la perspectiva de la observación del niño se utiliza en la documentación real)
4. Portafolios individuales (documentación utilizada para seguir y destacar el desarrollo de cada niño)
5. Documentación electrónica (utilizando aplicaciones y dispositivos para compartir documentación con familias y colaboradores)
6. Transcripciones o grabaciones de conversaciones (el uso de grabaciones en la documentación puede generar reflexiones más profundas tanto para el educador como para el niño)
7. Historias de aprendizaje (una narrativa utilizada para "describir el aprendizaje y ayudar a los niños a verse a sí mismos como estudiantes poderosos" ^[13] )
8. El aula como documentación (reflexiones y documentación del entorno físico de un aula). ^[13]

La documentación es, sin duda, un proceso en sí mismo y también es un proceso dentro del educador. A continuación se muestra el desarrollo de la documentación a medida que avanza para y dentro del educador:

• Desarrollar hábitos de documentación
• Sentirse cómodo al hacer público el relato de actividades.
• Desarrollar habilidades de alfabetización visual
• Conceptualiza el propósito de la documentación como hacer visibles los estilos de aprendizaje y
• Compartir(es) teorías visibles con fines de interpretación y de diseño curricular. ^[15]

Busque documentación en Wikcionario, el diccionario libre.

• Sociedad de comunicación profesional del IEEE
• Definición de documentación de The Linux Information Project (LINFO)
• Información y documentación Lista de herramientas seleccionadas
• Biblioteca de artículos sobre documentación: Artículos técnicos y de documentación Archivado el 18 de abril de 2010 en Wayback Machine.
• PERMISO DE CONDUCIR IRLANDÉS, INFORMACIÓN Y DOCUMENTACIÓN