[RFC-ADN-01] Normalizar nomenclatura de proyectos
- Directorios: PascalCase (p2601_dasuten → P2601_Dasuten) - Planes: numeración pura (P2601_6.1.A → P2601.06.01) - Sin caracteres especiales en nombres de archivo - 07_proyectos.md: convención RFC-ADN-01 integrada, P2604/P2605 agregados - evento:listar: nueva opción --detalle para descripciones completas
This commit is contained in:
@@ -0,0 +1,203 @@
|
||||
# RFC-ADN-01
|
||||
|
||||
## Convención de Identificación y Documentación de Proyectos
|
||||
|
||||
### Estado
|
||||
|
||||
Propuesta
|
||||
|
||||
### Alcance
|
||||
|
||||
Esta convención define el **esquema de identificación, estructura y documentación de proyectos** dentro del repositorio, principalmente en:
|
||||
|
||||
```
|
||||
docs/proy
|
||||
```
|
||||
|
||||
Su objetivo es garantizar:
|
||||
|
||||
* consistencia
|
||||
* trazabilidad
|
||||
* fácil navegación
|
||||
* reutilización del conocimiento
|
||||
* automatización futura
|
||||
|
||||
---
|
||||
|
||||
# 1. Identificación de proyectos
|
||||
|
||||
Cada proyecto debe tener un **identificador único**.
|
||||
|
||||
### Formato
|
||||
|
||||
```
|
||||
PYYNN_TEMA
|
||||
```
|
||||
|
||||
Donde:
|
||||
|
||||
| Elemento | Significado |
|
||||
| -------- | ------------------------ |
|
||||
| P | Prefijo de proyecto |
|
||||
| YY | Año de creación |
|
||||
| NN | Número correlativo |
|
||||
| TEMA | Nombre corto descriptivo |
|
||||
|
||||
### Ejemplo
|
||||
|
||||
```
|
||||
P2601_Dasuten
|
||||
```
|
||||
|
||||
Interpretación:
|
||||
|
||||
* Proyecto 01
|
||||
* Año 2026
|
||||
* Tema: Dasuten
|
||||
|
||||
---
|
||||
|
||||
# 2. Estructura de secciones
|
||||
|
||||
Cada proyecto puede dividirse en **secciones y subsecciones**.
|
||||
|
||||
### Formato
|
||||
|
||||
```
|
||||
PYYNN.NN.NN.TEMA
|
||||
```
|
||||
|
||||
| Elemento | Significado |
|
||||
| -------- | -------------------------- |
|
||||
| PYYNN | Identificador del proyecto |
|
||||
| NN | Sección |
|
||||
| NN | Subsección |
|
||||
| TEMA | Nombre corto |
|
||||
|
||||
### Ejemplo
|
||||
|
||||
```
|
||||
P2601.01.01.Red-SrvDasu
|
||||
```
|
||||
|
||||
Interpretación:
|
||||
|
||||
* Proyecto: P2601
|
||||
* Sección: 01
|
||||
* Subsección: 01
|
||||
* Tema: Red del servidor Dasu
|
||||
|
||||
---
|
||||
|
||||
# 3. Datos de cabecera del proyecto
|
||||
|
||||
Cada proyecto debe iniciar con un bloque de metadatos.
|
||||
|
||||
Ejemplo:
|
||||
|
||||
```
|
||||
Proyecto: P2601_Dasuten
|
||||
Estado: En desarrollo
|
||||
Versión: v0.1
|
||||
Responsable: TIC
|
||||
Fecha inicio: 2026
|
||||
Ámbito: Infraestructura / Sistemas
|
||||
```
|
||||
|
||||
Campos recomendados:
|
||||
|
||||
* Proyecto
|
||||
* Estado
|
||||
* Versión
|
||||
* Fecha inicio
|
||||
* Responsable
|
||||
* Ámbito
|
||||
* Contexto
|
||||
* Objetivo
|
||||
|
||||
---
|
||||
|
||||
# 4. Estructura sugerida de documentación
|
||||
|
||||
Dentro de cada proyecto:
|
||||
|
||||
```
|
||||
docs/proy/
|
||||
|
||||
P2601_Dasuten/
|
||||
│
|
||||
├── README.md
|
||||
├── bitacora.md
|
||||
├── plan.md
|
||||
│
|
||||
├── 01_contexto.md
|
||||
├── 02_arquitectura.md
|
||||
├── 03_implementacion.md
|
||||
├── 04_operacion.md
|
||||
├── 05_mejoras.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 5. Principios de diseño
|
||||
|
||||
La documentación debe seguir estos principios:
|
||||
|
||||
### Simplicidad
|
||||
|
||||
Evitar estructuras complejas.
|
||||
|
||||
### Escalabilidad
|
||||
|
||||
Debe funcionar tanto para proyectos pequeños como grandes.
|
||||
|
||||
### Navegabilidad
|
||||
|
||||
La estructura debe ser fácilmente entendible.
|
||||
|
||||
### Automatización futura
|
||||
|
||||
La nomenclatura debe permitir:
|
||||
|
||||
* generación automática de índices
|
||||
* scripts de documentación
|
||||
* trazabilidad entre proyectos
|
||||
|
||||
---
|
||||
|
||||
# 6. Integración con ecosistema ADN
|
||||
|
||||
Este estándar debe integrarse con el ecosistema ADN.
|
||||
|
||||
En particular:
|
||||
|
||||
* herramientas de documentación
|
||||
* generación de plantillas
|
||||
* bitácoras de proyectos
|
||||
* automatización de repositorios
|
||||
|
||||
Referencia principal:
|
||||
|
||||
```
|
||||
adn/README.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
# 7. Mejora continua
|
||||
|
||||
Este estándar **no es definitivo**.
|
||||
|
||||
Debe evolucionar mediante:
|
||||
|
||||
* nuevas necesidades
|
||||
* retroalimentación del uso real
|
||||
* optimización de herramientas ADN
|
||||
|
||||
---
|
||||
|
||||
# Principio rector
|
||||
|
||||
**Menos es más.
|
||||
Mejora continua.
|
||||
Armonía integral.**
|
||||
Reference in New Issue
Block a user