workspace-v1/shared/knowledge-base/templates/module-template/USAGE.md

# Guia de Uso: {Nombre del Modulo}

**Modulo:** {module-id}
**Version:** X.Y.Z

---

## Prerequisitos

- [ ] Node.js 18+
- [ ] {Framework} configurado
- [ ] Base de datos PostgreSQL (si aplica)
- [ ] Variables de entorno configuradas

## Paso 1: Instalacion

### Opcion A: Copia Directa

```bash
# Desde el knowledge-base
cp -r /path/to/knowledge-base/modules/{categoria}/{modulo}/src \
      your-project/src/modules/{modulo}
```

### Opcion B: Como Dependencia

```bash
# Si esta publicado como package
npm install @workspace/{modulo}
```

## Paso 2: Configuracion

### 2.1 Variables de Entorno

Crear/actualizar `.env`:

```env
# Configuracion {MODULO}
{MODULO}_ENABLED=true
{MODULO}_API_KEY=your-api-key
{MODULO}_SECRET=your-secret
```

### 2.2 Configuracion en Codigo

```typescript
// config/{modulo}.config.ts
export default () => ({
  {modulo}: {
    enabled: process.env.{MODULO}_ENABLED === 'true',
    apiKey: process.env.{MODULO}_API_KEY,
    secret: process.env.{MODULO}_SECRET,
  },
});
```

## Paso 3: Integracion

### 3.1 Importar Modulo

```typescript
// app.module.ts
import { {Module}Module } from './modules/{modulo}/{modulo}.module';

@Module({
  imports: [
    ConfigModule.forRoot(),
    {Module}Module.forRootAsync({
      imports: [ConfigModule],
      useFactory: (configService: ConfigService) => ({
        apiKey: configService.get('{MODULO}_API_KEY'),
        // ... mas opciones
      }),
      inject: [ConfigService],
    }),
  ],
})
export class AppModule {}
```

### 3.2 Uso en Servicios

```typescript
// your.service.ts
import { {Module}Service } from './modules/{modulo}/{modulo}.service';

@Injectable()
export class YourService {
  constructor(private readonly {modulo}Service: {Module}Service) {}

  async someMethod() {
    // Usar el servicio
    const result = await this.{modulo}Service.doSomething();
    return result;
  }
}
```

## Paso 4: Verificacion

### 4.1 Tests

```bash
# Ejecutar tests del modulo
npm run test -- --grep="{modulo}"
```

### 4.2 Checklist

- [ ] Modulo importado en AppModule
- [ ] Variables de entorno configuradas
- [ ] Dependencias instaladas
- [ ] Build pasa sin errores
- [ ] Tests pasan

## Ejemplos de Uso

### Ejemplo Basico

```typescript
// Uso simple
const result = await {modulo}Service.basicOperation();
```

### Ejemplo Avanzado

```typescript
// Uso con opciones
const result = await {modulo}Service.advancedOperation({
  option1: 'value1',
  option2: 'value2',
});
```

## Troubleshooting

### Error: "{MODULO}_API_KEY not defined"

**Causa:** Variable de entorno no configurada.
**Solucion:** Agregar `{MODULO}_API_KEY=value` al archivo `.env`.

### Error: "Module not found"

**Causa:** Modulo no importado correctamente.
**Solucion:** Verificar import en `app.module.ts`.

## Soporte

- Documentacion: [README.md](./README.md)
- API Reference: [API.md](./API.md)
- Ejemplos: [examples/](./examples/)

---

**Siguiente paso:** Ver [API.md](./API.md) para referencia completa de la API.