Versión: 0.2
Fecha: AAAA-MM-DD
Responsable: [Nombre]
Estado: Borrador / En revisión / Aprobado
1. Descripción General (*)
| Parámetro | Valor |
|---|
| Tipo de software | |
| Lenguaje(s) | |
| Framework(s) | |
| Plataforma de ejecución | |
| Repositorio / Ruta | /software/ |
2. Versiones de Software (*)
| Versión | Fecha | Cambios principales | Compatible con FW |
|---|
| | | |
3. Arquitectura de Software (*)
3.1 Componentes Principales
| Componente | Descripción | Tecnología | Ruta |
|---|
| | | |
4. Módulos de Software (*)
| Módulo | Descripción | Ruta | Dependencias |
|---|
| | | |
5. Interfaces y API (○)
5.1 API REST (○ — solo si hay API)
| Endpoint | Método | Descripción | Request | Response |
|---|
| | | | |
5.2 Protocolo con Dispositivo (○ — solo si hay FW)
6. Modelo de Datos (○)
6.1 Entidades Principales
6.2 Diagrama ER (○)
7. Flujos Principales (○)
D: 201 Created
UI->>B: GET /api/measurements
B-->>UI: JSON con datos
-->
8. Estándar de Código (○)
| Lenguaje | Guía de estilo | Linter / Formatter |
|---|
| | |
9. Dependencias Externas (○)
Archivo de dependencias: requirements.txt / package.json / pyproject.toml
| Librería / Servicio | Versión | Propósito | Licencia |
|---|
| | | |
10. Despliegue y Configuración (○)
10.1 Variables de Entorno
| Variable | Descripción | Valor por defecto |
|---|
| | |
10.2 Instrucciones de Instalación
11. Decisiones de Diseño (*)
| # | Decisión | Alternativas | Razón | Fecha |
|---|
| 1 | | | | |
12. Documentación del Código (○)
| Campo | Detalle |
|---|
| Herramienta | |
| Comando para generar | |
| Documentación generada (local) | |
| Documentación publicada (○) | [URL del sitio generado, si se despliega] |
| Cobertura esperada | Todas las funciones públicas / Solo módulos críticos |
13. Historial de Cambios (*)
| Versión | Fecha | Autor | Cambios | Motivo |
|---|
| 0.1 | AAAA-MM-DD | | Creación inicial | |
| 0.2 | AAAA-MM-DD | | Creación inicial | |