Especificación de producto, ficha técnica o resumen de API: qué plantilla usar
Beta privada. El acceso es por lista de espera y los planes de pago se abren cuando termine la beta. Apúntate a la lista de espera.
«Especificación» abarca documentos muy distintos. Wordspecs empieza con tres plantillas, porque son los documentos que la mayoría de los equipos pequeños escriben con más frecuencia. Puedes ver un ejemplo de cada una en las hojas de ejemplo de la página de inicio.
Especificación de producto SaaS
Sirve para decidir qué construir y por qué. Los campos incluyen resumen, problema, objetivos, fuera de alcance, requisitos con prioridades, métricas de éxito, preguntas abiertas y un plan de lanzamiento. El lector es una persona de ingeniería, diseño o dirección que necesita saber qué entra en el alcance.
Ficha técnica de hardware
Sirve para describir qué es y qué hace un producto físico. Los campos incluyen descripción, características principales, características eléctricas con valores mínimo, típico y máximo, límites ambientales, detalles mecánicos, datos de radio e información de pedido. El lector es una persona de ingeniería o de compras que compara piezas.
Resumen de API
Sirve para explicar a un desarrollador cómo integrarse. Los campos incluyen resumen, URL base, autenticación, endpoints, límites de uso, versionado y códigos de error. El lector es un desarrollador que decide si la API encaja y cómo empezar.
Cómo elegir
- Decidir qué construir: especificación de producto.
- Describir algo que fabricas o vendes: ficha técnica.
- Describir cómo llamar a tu servicio: resumen de API.
Los ejemplos del sitio son inventados, solo para ilustrar. Si tus documentos son distintos, las plantillas guardadas te permiten conservar tu propio formato.