
Guía de colección de API – plantilla para Google Docs
Docs + Word7 páginas
Gratis
Los equipos pequeños de ingeniería evitan los documentos de diseño porque la plantilla habitual parece un trámite de comité, y luego discuten el enfoque dentro de los pull requests. Esta plantilla de diseño técnico sirve para cambios que requieren acuerdo, pero no una revisión formal: el problema con una cifra medida, objetivos y no objetivos, la propuesta, las opciones puntuadas con honestidad, el despliegue con su reversión y las preguntas abiertas con responsable.
El ejemplo es una nota de Larkspur Software, empresa ficticia, sobre sacar el envío de webhooks del flujo de solicitudes de la API. Parte de 1,200 solicitudes por segundo con un pico de 3 veces, un objetivo de p95 menor a 200 ms, un costo mensual adicional de $6k y un esfuerzo de cinco semanas-ingeniero. Sustituye contexto, alternativas, fechas y dueños por los de tu proyecto, y quita las secciones que sobren.
Con Hacer una copia recibirás en tu Drive la nota de diseño, lista para editar.
Sustituye el problema por la molestia real de usuarios u operación, con una cifra medida, y reescribe los objetivos y no objetivos.
Cambia las alternativas de ejemplo por las opciones que tu equipo discutió de verdad, y puntúalas con honestidad.
Actualiza las puertas y el calendario, y asigna a cada pregunta abierta un responsable y una fecha límite de decisión.
Borra la página Personalízala y comparte el documento con quienes lo revisarán.
Cuando un cambio necesita el visto bueno de otros ingenieros, pero no una revisión completa de arquitectura: una cola nueva, un cambio de esquema o el reemplazo de una dependencia. Apunta a entre dos y seis páginas.
No. La firma, su gente, los buzones de correo y cada número del texto son inventos. Sustitúyelos por tus datos y tus responsables.
No. Borra la sección del modelo de datos si no cambia el esquema, pero deja las alternativas y una ruta de reversión. Los revisores confían más en un diseño que muestra lo que descartó.
Más plantillas de Google Docs (en inglés)Más plantillas de flujos de desarrollo

Docs + Word7 páginas
Gratis
Docs + Word8 páginas
Gratis
Docs + Word7 páginas
Gratis
Docs + Word10 páginas
Gratis
Docs + Word10 páginas
Gratis
Docs + Word10 páginas
Gratis
Slides + PowerPoint10 diapositivas
Gratis
Docs + Word9 páginas
Gratis
Docs + Word9 páginas
Gratis
Slides + PowerPoint10 diapositivas
Gratis