{"id":37644106,"url":"https://github.com/virtualitems/documentation","last_synced_at":"2026-01-16T11:23:53.112Z","repository":{"id":160067957,"uuid":"635026497","full_name":"virtualitems/documentation","owner":"virtualitems","description":"Manual de referencia para escribir documentación","archived":false,"fork":false,"pushed_at":"2024-08-16T08:14:49.000Z","size":93,"stargazers_count":1,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-08-16T09:35:07.203Z","etag":null,"topics":["documentacion","documentation","escritura","escritura-academica","escritura-tecnica","technical-writing","writing"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/virtualitems.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-01T19:56:18.000Z","updated_at":"2024-08-16T09:35:10.213Z","dependencies_parsed_at":"2024-01-02T16:48:55.014Z","dependency_job_id":null,"html_url":"https://github.com/virtualitems/documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/virtualitems/documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualitems%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualitems%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualitems%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualitems%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/virtualitems","download_url":"https://codeload.github.com/virtualitems/documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/virtualitems%2Fdocumentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478228,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentacion","documentation","escritura","escritura-academica","escritura-tecnica","technical-writing","writing"],"created_at":"2026-01-16T11:23:52.408Z","updated_at":"2026-01-16T11:23:53.102Z","avatar_url":"https://github.com/virtualitems.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Manual de documentación de software\n\nCon el objetivo de consolidar lo aprendido acerca de documentación de software, se ha creado este repositorio como manual de referencia para futuros proyectos.\n\n\u003cbr\u003e\n\n# ¿Qué es documentación de software?\n\nLa documentación de software es un conjunto de documentos que describen el sistema desde múltiples perspectivas.\n\nSu propósito es facilitar el uso, mantenimiento y desarrollo del software.\n\nLos usuarios pueden usar la documentación para aprender cómo usar el sistema, mientras que los desarrolladores pueden usarla para comprender el diseño o la implementación del sistema.\n\n\u003cbr\u003e\n\n# ¿Por qué es importante la documentación de software?\n\nLa documentación de software es importante porque:\n\n- **Mejora la calidad del software**: La documentación ayuda a evitar errores, inconsistencias y ambigüedades en las funcionalidades del sistema, así como a facilitar la detección y corrección de defectos.\n\n- **Facilita la comunicación y colaboración**: La documentación permite a los diferentes actores involucrados en el proyecto (clientes, usuarios, devs, testers, etc.) entender los requisitos, funcionalidades y limitaciones del sistema.\n\n- **Reduce el costo y el tiempo de desarrollo**: La documentación ayuda a planificar, organizar y gestionar el proyecto, así como a reutilizar código o componentes existentes. También evita la pérdida de información o conocimiento cuando se produce un cambio de personal o de tecnología.\n\n\u003cbr\u003e\n\n# Clasificación de la documentación de software\n\nExisten diferentes tipos de documentación de software. Con el fin de facilitar su comprensión, personalmente los clasifico según tres dimensiones:\n\n- **El elemento documentado:** La primera dimensión se refiere al elemento en sí. Por ejemplo: un requisito, un procedimiento, código, etc.\n\n- **El perfil del lector:** La segunda dimensión corresponde a quién va dirigido el documento. Por ejemplo: desarrolladores, usuarios, analistas, etc.\n\n- **El propósito de la documentación:** La tercera dimensión es el tipo de información que se desea comunicar. Por ejemplo: descripción actual del sistema, especificación de lo que se implementará, etc.\n\nEsto se explica detalladamente [aquí](docs/classification.md).\n\n\u003cbr\u003e\n\n# Metadatos de un documento de software\n\nLos metadatos son datos acerca del documento en sí.\n\nPara la documentación de software se recomienda incluir los siguientes metadatos: [Lista de metadatos](docs/meta.md)\n\n\u003cbr\u003e\n\n# Niveles de documentación de software\n\n*Más conceptual*\n\n- [Visión (vision)](docs/levels/visions.md): Es la declaración previsora de lo que se espera del proyecto en el futuro.\n\n- [Épica (epic)](docs/levels/epics.md): Es un grupo de funcionalidades o características que responden a una misma necesidad que el sistema debe satisfacer.\n\n- [Característica (feature)](docs/levels/features.md): Es una funcionalidad definida por un conjunto de interacciones.\n\n- [Caso de uso (user story)](docs/levels/use_cases.md): Es la descripción de una interacción con sistema desde la perspectiva del usuario.\n\n- [Implementación (implementation)](docs/levels/implementation.md): Es la descripción técnica de cómo se implementó una funcionalidad.\n\n*Más técnico*\n\n\u003e Ejemplo:\n\u003e\n\u003e**Software de gestión para una bodega de productos _(Visión)_**\n\u003e\n\u003e- Control de inventario _(Épica)_\n\u003e    - Gestión de proveedores _(Característica)_\n\u003e    - Programación de Alertas _(Característica)_\n\u003e    - Reportes de inventario _(Característica)_\n\u003e    - Gestión de productos _(Característica)_\n\u003e        - Ingresar producto con rol de almacenista _(Caso de uso)_\n\u003e            - Algoritmo de ingreso de producto _(Implementación)_\n\n\u003cbr\u003e\n\n# Fases de la documentación de software\n\nLas Fases del Desarrollo son los pasos que se siguen al realizar un proyecto de documentación de software.\n\nEstas fases son:\n\n- [Preámbulo](docs/phases/preamble.md): El primer paso del proceso de documentación es conocer la metainformación del trabajo que se debe realizar.\n\n- [Exploración](docs/phases/exploration.md): Durante la exploración debes comprender el contexto del sistema y determinar los procedimientos actuales utilizados por los usuarios.\n\n- [Análisis](docs/phases/analisys.md): El análisis de requerimientos implica identificar las necesidades de los usuarios y los criterios de aceptación para la solución que se proponga.\n\n- [Diseño](docs/phases/design.md): Para el diseño de la solución debes presentar diferentes alternativas como solución a la necesidad y seleccionar la más adecuada.\n\n- [Implementación](docs/phases/implementation.md): Haz seguimiento al desarrollo y agrega textos técnicos acerca de la implementación.\n\n- [Entrega](docs/phases/delivery.md): Agrega detalles, notas y advertencias finales. Entrega la solución creada con la documentación correspondiente.\n\n\u003cbr\u003e\n\n# Secciones de un documento de software\n\n_**Abstract**_\n- [Página inicial](docs/phases/preamble.md)\n- [Prefacio](docs/phases/preamble.md)\n- [Glosario](docs/phases/exploration.md)\n\n_**Documentación no técnica** (La documentación no técnica son descripciones e instrucciones claras para un público que puede no estar familiarizado con los detalles del sistema o los procesos.)_\n\n- [Anexos](docs/phases/preamble.md)\n- [Reuniones](docs/phases/exploration.md)\n- [Procesos](docs/phases/exploration.md)\n- [Requerimientos](docs/phases/analisys.md)\n- [Casos de uso](docs/phases/design.md)\n- [Plan de pruebas](docs/phases/design.md)\n- [Notas y advertencias acerca de las decisiones tomadas](docs/phases/design.md)\n\n_**Documentación técnica** (La documentación técnica describe y explica aspectos tecnológicos, características y funciones del software, como su arquitectura, diseño, algoritmos o APIs, con el objetivo de facilitar su comprensión, mantenimiento y colaboración entre desarrolladores.)_\n\n- [Topología](docs/phases/implementation.md)\n- [Componentes de software](docs/phases/implementation.md)\n- [Diagramas de bases de datos](docs/phases/implementation.md)\n- [Especificación de APIs](docs/phases/implementation.md)\n- [Algoritmos de servicios](docs/phases/implementation.md)\n- [Lista de nuevos permisos](docs/phases/implementation.md)\n- [Tareas y actividades](docs/phases/implementation.md)\n\n_**Documentación de entrega** (La documentación de entrega va dirigidada a los usuarios finales del sistema)_\n\n- [Manual de instalación](docs/phases/delivery.md)\n- [Manual de uso](docs/phases/delivery.md)\n- [Registro de cambios](docs/phases/delivery.md)\n\n\u003cbr\u003e\n\n# Apéndices\n\n- [Flujo de trabajo](docs/workflow.md)\n\n- [Navegación y estructura](docs/navigation.md)\n\n- [Licencias](docs/licenses.md)\n\n- [Referencias](docs/references.md)\n\n- Documentación basada en texto\n    - [listas](/docs/text/lists.md)\n    - [tablas](/docs/text/tables.md)\n    - [código](/docs/text/code.md)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtualitems%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvirtualitems%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvirtualitems%2Fdocumentation/lists"}