Spécification produit, fiche technique ou aperçu d'API : quel modèle choisir
Bêta privée. L'accès se fait par liste d'attente, et les offres payantes ouvrent à la fin de la bêta. Rejoignez la liste d'attente.
« Spécification » recouvre plusieurs documents différents. Wordspecs démarre avec trois modèles, parce que ce sont les documents que les petites équipes rédigent le plus souvent. Vous pouvez voir un exemple de chacun dans les fiches d'exemple de la page d'accueil.
Spécification produit SaaS
Pour décider quoi construire et pourquoi. Les champs comprennent le résumé, le problème, les objectifs, le hors-périmètre, les exigences avec priorités, les indicateurs de réussite, les questions ouvertes et un plan de déploiement. Le lecteur est une personne de l'ingénierie, du design ou de la direction qui doit savoir ce qui entre dans le périmètre.
Fiche technique matérielle
Pour décrire ce qu'est et ce que fait un produit physique. Les champs comprennent la description, les caractéristiques principales, les caractéristiques électriques avec valeurs minimale, typique et maximale, les limites environnementales, les détails mécaniques, les informations radio et les informations de commande. Le lecteur est un ingénieur ou un acheteur qui compare des composants.
Aperçu d'API
Pour expliquer à un développeur comment s'intégrer. Les champs comprennent le résumé, l'URL de base, l'authentification, les points d'accès, les limites de débit, la gestion des versions et les codes d'erreur. Le lecteur est un développeur qui décide si l'API lui convient et comment démarrer.
Choisir
- Décider quoi construire : spécification produit.
- Décrire ce que vous fabriquez ou vendez : fiche technique.
- Décrire comment appeler votre service : aperçu d'API.
Les exemples du site sont inventés, à titre d'illustration uniquement. Si vos documents sont différents, les modèles enregistrés vous permettent de garder votre propre format.