---
# System prepended metadata

title: Estructura documentación
tags: [alea]

---

# Estructura documentación

###### tags: `alea`

[TOC]

Ahora mismo la realidad es que el Freshdesk es de Operaciones y tenemos una categoría "Desarrollo" para nosotros.

[Docu desarrollo actual](https://soporte.alea-soluciones.com/a/solutions/categories/12000001766/folders/12000009425)

- Fresdesk solo tiene 3 niveles jerárquicos: Categoría > Carpeta > Artículo
- Tags

https://support.freshservice.com/support/solutions/articles/156521-understanding-the-three-level-solutions-hierarchy

**Estructura propuesta**

## Equipo desarrollo

### Onboarding/Pack de bienvenida
  - Bienvenida / Welcome pack
  - Convivencia en la oficina
  - Rutinas
  - Valores Equipo Bifer
  - Herramientas Productividad

### Entender el negocio (compartida con toda la empresa quizás)
  - Vista de pájaro global
  - Mundo Mutualizado
  - Mundo Felix*
  - Recursos
  - ...

### Componentes (empezar la página con [COMPONENTE] o usar tags)
  - Felix*
  - Provision*
  - Karajan
  - Adagio/Limox
  - eXtension*
  - ...

### Infraestructura
  - Docker
  - Ansible
  - Redis
  - Postgres
  - Olts/SNMP
  - Sentry
  - ...

###  Operativa/Soluciones/Incidencias/Trucos
  - Despliegues
  - Como actualizar los samples de /etc/felix/acs, /etc/felix/huaweiolt_provision y /et
  - Cómo activar y desactivar DEBUG logging
  - Inspección de comunicaciones de red
  - ...

### Sistemas
  - Parámetros que indican fallo de disco
  - Esquema de servidores y servicios de Alea
  - DNS en Alea
  - Panel de control proxmox / pve
  - Cambio de password de asur y root en los sistemas de clientes
  - ...

### Desarrollo
  - Entorno local de desarrollo
  - Acuerdos estilos de código
  - Acuerdos de estilo para mensajes de commit en git
  - Como hacer Profile en Python
  - ...

## Dudas etc.

- Añadir en cada carpeta, un "artículo indice" que tenga una tabla de contenidos mínimamente estructurada. **OJO, mantenimiento manual**
- A los artículos se les puede [añadir una TOC automática](https://support.freshdesk.com/support/solutions/articles/50000002051-using-advanced-formatting-options-in-the-knowledge-base#A-quick-guide-to-using-Table-of-content)
- Puede que una de estas carpetas pasa a nivel de categoría más adelante si el volumen de artículos así lo "pide". Estructura viva.
- Curiosidad: idioma español?

:::warning
¿Cómo casamos todo esto con lo que hay ahora (que no depende solo de nosotros...)?
:::

(*) ¿Vale la pena invertir aquí?

