Gute Dokumentation entscheidet darüber, ob Entwickler ein Tool nur testen oder dauerhaft nutzen.
Heute starten wir foura.ai/docs, eine vollständige Dokumentationsseite für die FourA-Plattform.
Was enthalten ist
Erste Schritte
Alles, was du brauchst, um in unter zwei Minuten von der Registrierung zur ersten erfolgreichen Datenerfassung zu gelangen. Schnellstartanleitung, Authentifizierungs-Setup und Beispiele in Python, Node.js, Go, Ruby und cURL.
API-Referenz
Vollständige Endpoint-Dokumentation mit Request-Parametern, Response-Formaten, Fehlercodes und Beispielen zum Kopieren für jede Operation.
Anleitungen
Vertiefende Einblicke in FourA-Konzepte: wie du den richtigen Task-Typ für deinen Anwendungsfall wählst, wie du mit geschützten Websites arbeitest und wie du Leistung sowie Kosten optimierst.
How-To-Tutorials
Schritt-für-Schritt-Anleitungen für spezifische Aufgaben: Scraping dynamischer Websites, Monitoring von Mitbewerberpreisen und wöchentlich neue Inhalte.
Fehlerbehebung
Lösungen für häufige Probleme, von leeren Responses und Timeout-Fehlern bis hin zu Authentifizierungsproblemen und Rate Limits.
Für Entwickler gebaut
Die Dokumentation wurde mit Fokus auf die Developer Experience entwickelt:
- Suche über die gesamte Dokumentation mit Volltextsuche
- Sidebar-Navigation, nach Themen strukturiert
- Inhaltsverzeichnis auf jeder Seite für schnelles Springen
- Vor/Zurück-Navigation für sequenzielles Lesen
- Mobile-friendly Layout, das auf jedem Gerät funktioniert
Ja, es funktioniert also auch auf deinem Smartphone.
Was als Nächstes kommt
Dokumentation ist ein lebendiges Produkt. Wir fügen basierend auf Nutzerfeedback jede Woche neue Leitfäden und Tutorials hinzu. Das kommt in Kürze:
- SDK-Schnellstarts für Python und Node.js
- Dokumentation für Webhooks und Callbacks
- Erweiterter Leitfaden zur Proxy-Konfiguration
- Integrationsbeispiele (n8n, Zapier, Make)
Feedback willkommen
Tippfehler gefunden? Fehlt ein Thema? Schreib uns an support@foura.ai. Die beste Dokumentation wird von den Leuten geprägt, die sie tatsächlich nutzen (nicht von denen, die sie schreiben), also halte dich nicht zurück.