1. Introducción - UPT-FAING-EPIS/proyecto-si889-2025-i-u2-leyva_chambi_floresq GitHub Wiki

Introducción

El presente informe tiene como objetivo evaluar la viabilidad y el impacto de la implementación de un sistema web para la conversión y organización de documentos técnicos en Markdown. A través de esta plataforma, se busca mejorar la gestión de documentación académica en la Facultad de Ingeniería de Sistemas, facilitando la migración de documentos desde formatos tradicionales como Word, PDF, HTML y TXT a un estándar más estructurado y compatible con plataformas de documentación como GitHub.

En este documento, se analizarán los beneficios del sistema desde diversas perspectivas: técnica, operativa, académica y de usabilidad. Se abordarán los problemas actuales en la gestión de documentación técnica y se explicará cómo la aplicación propuesta optimizará la conversión de documentos, el mantenimiento de versiones y la estructuración automática de contenidos.


Propósito

El propósito de este proyecto es diseñar e implementar una plataforma web que permita la conversión automatizada de documentos técnicos en diferentes formatos a Markdown, garantizando la preservación de la estructura y facilitando la organización de la información.

A través de esta herramienta, se busca optimizar la documentación académica, permitiendo a los estudiantes generar archivos bien estructurados para su uso en repositorios de control de versiones y otras plataformas colaborativas.


Alcance

El alcance del proyecto incluye el desarrollo de un sistema web que permita:

  • Convertir automáticamente documentos en formatos Word (.docx), PDF, HTML y TXT a Markdown (.md), asegurando la preservación de títulos, listas y otros formatos.
  • Generar archivos de navegación automática (_Sidebar.md, _Footer.md) basados en la estructura del documento original.
  • Ofrecer una visualización previa del documento convertido para garantizar la fidelidad del formato.
  • Incorporar una funcionalidad de traducción automática para cambiar el idioma del contenido.
  • Permitir la autenticación de usuarios para gestionar versiones previas de los documentos.
  • Facilitar la descarga de los archivos convertidos en Markdown listos para su uso en plataformas de documentación.

Definiciones, Siglas y Abreviaturas

  • Markdown (.md): Lenguaje de marcado ligero utilizado para la creación de documentación estructurada.
  • Conversión automática: Proceso de transformar documentos en otros formatos a Markdown sin intervención manual.
  • Sidebar.md / Footer.md: Archivos de navegación generados automáticamente para facilitar la estructura del contenido.
  • Control de versiones: Mecanismo para gestionar diferentes versiones de un documento en el tiempo.
  • Traducción automática: Funcionalidad que permite convertir documentos de un idioma a otro dentro del sistema.

Referencias

El desarrollo de este proyecto toma en cuenta los principios y mejores prácticas en la gestión de documentación técnica, así como estándares de accesibilidad y usabilidad en plataformas web. Se consideran metodologías ágiles para el desarrollo del sistema y normativas relacionadas con la gestión de información académica.


Visión General

La plataforma web de conversión y organización de documentos técnicos en Markdown permitirá a los estudiantes de la Facultad de Ingeniería de Sistemas optimizar la migración de sus documentos a un formato más estandarizado y accesible. Con funcionalidades como la conversión automatizada, la estructuración de títulos y la gestión de versiones, el sistema facilitará el trabajo académico y la integración con herramientas colaborativas como GitHub.