Help Center and Developer Docs
Two portals, two audiences (ADR-039).
Source: docs/adr/ADR-039-help-center-and-developer-docs.md
ADR-039: Help Center y Developer Docs
Estado: Accepted — 2026-11-12. Ratificación humana explícita en aprobación de plataforma; conserva las decisiones Accepted previas.
Contexto
Usuarios externos e integradores requieren asistencia y contratos claros, sin acceso a funciones ERP privadas.
Decisión
- Help Center para artículos públicos/privados, búsqueda, categorías, tickets y enlaces desde portal.
- Developer Docs basadas en OpenAPI, guías, autenticación de integradores, changelog y versionado.
- Las APIs externas se publican con scopes, cuotas, rate limiting y separación explícita de endpoints internos; sin exponer datos internos.
- Contenido EN/ES cuando aplique y visibilidad por permisos; editor CMS/proveedor a seleccionar por spike.
- No prometer soporte SLA, public API o SDK antes de establecer alcance contractual.
Alternativas y trade-offs
- Reutilizar conceptos validados de FoodHUB, sin trasplantar automáticamente su dominio restaurante, tenancy o código.
- Mantener una solución modular y evolutiva antes de añadir servicios y proveedores.
- Motor de búsqueda, CMS y hosting documental quedan abiertos.
Consecuencias
Este ADR orienta briefs, specs, controles y pruebas. No autoriza implementar features sin DOC-012/DOC-013. Revisión de privacidad/seguridad/finanzas antes del release pertinente.
Referencias
DOC-001 v2.0 · DOC-002 · DOC-017 · DOC-018 · ADR-010/011/012/013/014/015/024/025/032/033.