Produktspezifikation, Datenblatt oder API-Übersicht: welche Vorlage passt
Private Beta. Der Zugang läuft über die Warteliste, und die kostenpflichtigen Tarife starten, wenn die Beta endet. Tragen Sie sich auf die Warteliste ein.
„Spezifikation“ umfasst ganz unterschiedliche Dokumente. Wordspecs startet mit drei Vorlagen, weil kleine Teams diese Dokumente am häufigsten schreiben. Ein gerendertes Beispiel jeder Vorlage finden Sie in den Beispielblättern auf der Startseite.
SaaS-Produktspezifikation
Zur Entscheidung, was gebaut wird und warum. Die Felder umfassen Zusammenfassung, Problem, Ziele, Nicht-Ziele, Anforderungen mit Prioritäten, Erfolgskennzahlen, offene Fragen und einen Veröffentlichungsplan. Leser ist eine Person aus Entwicklung, Design oder Management, die wissen muss, was zum Umfang gehört.
Hardware-Datenblatt
Zur Beschreibung dessen, was ein physisches Produkt ist und kann. Die Felder umfassen Beschreibung, wichtige Merkmale, elektrische Kennwerte mit Minimal-, Typ- und Maximalwerten, Umgebungsgrenzen, mechanische Angaben, Funkangaben und Bestellinformationen. Leser ist eine Person aus der Entwicklung oder dem Einkauf, die Teile vergleicht.
API-Übersicht
Um Entwicklern zu zeigen, wie sie sich anbinden. Die Felder umfassen Zusammenfassung, Basis-URL, Authentifizierung, Endpunkte, Ratenbegrenzung, Versionierung und Fehlercodes. Leser ist ein Entwickler, der entscheidet, ob die API passt und wie er anfängt.
Die Wahl
- Was gebaut wird entscheiden: Produktspezifikation.
- Etwas beschreiben, das Sie herstellen oder verkaufen: Datenblatt.
- Beschreiben, wie man Ihren Dienst aufruft: API-Übersicht.
Die Beispiele auf der Website sind erfunden und dienen nur der Veranschaulichung. Sehen Ihre Dokumente anders aus, bewahren gespeicherte Vorlagen Ihr eigenes Format.