Documentacion

La documentacion es la interfaz real de un SDK. Nadie lee el codigo fuente de una libreria, todo el mundo lee sus documentos.

Todavia no hay documentacion publicada. Ningun producto ha llegado a la fase de lanzamiento. Esta pagina explica el estandar que aplicaremos cuando la haya.

La regla de los diez minutos

Un desarrollador debe conseguir que algo funcione en menos de diez minutos desde que abre la documentacion. Si el inicio rapido no lo consigue, el problema es del producto o de sus documentos, y se corrige antes de lanzar.

Asi se ve un inicio rapido que cumple esa regla:

// 1. Inicializar el SDK una vez, al arrancar el juego.
Progress.Initialize(new YummanConfig {
    ProjectId = "tu-proyecto",
    ApiKey    = "tu-clave"
});

// 2. Avisar cuando el estado del juego cambie.
Progress.SetCurrentMission("mission_rescue_convoy", MissionType.Main);

// 3. Listo. El panel ya muestra la informacion de esa mision.

Estructura de cada SDK

Que es. Una frase: que problema resuelve.
Inicio rapido. El codigo minimo que funciona, listo para copiar.
Guias. Tareas concretas, paso a paso.
Referencia. Cada funcion publica, con ejemplo.
Conceptos. Por que esta disenado asi.
Migracion. Que cambia entre versiones.

Compromisos

Todo ejemplo se ejecuta. Se prueban de forma automatica. Un ejemplo roto es peor que ninguno, porque destruye la confianza en el resto.
Cada funcion publica indica para que sirve. Que hace, que recibe, que devuelve y que ocurre si falla.
Las limitaciones se declaran. Lo que un producto no hace se escribe antes de que lo descubras a mitad de integracion.
Espanol e ingles. Sin excepciones.

Compatibilidad

Usamos versionado semantico de forma estricta. Un SDK se integra en juegos que se publican y despues se parchean durante anos: romper la compatibilidad en una version menor obligaria a tocar el codigo de un juego ya publicado.

Un cambio incompatible sube version mayor. Siempre, aunque parezca pequeno.