Projektbeschreibung
ÜbersetztUnser Unternehmen hat eine REST-API entwickelt, die Partnerentwickler nutzen, um sich mit unserer Plattform zu integrieren, aber die aktuelle Dokumentation ist veraltet und über interne Wikis und alte Tabellen verstreut. Wir suchen einen erfahrenen technischen Redakteur, der unsere bestehenden Endpunkte in ein sauberes, strukturiertes Referenzdokument umwandeln kann, auf das Entwickler sich verlassen können, ohne jedes Mal unser Support-Team zu kontaktieren, wenn sie nicht weiterkommen.
Der Job umfasst jeden öffentlichen Endpunkt: klare Beschreibungen dessen, was jede Methode tut, eine vollständige Aufschlüsselung der erforderlichen und optionalen Parameter mit Typen und Standardwerten, Authentifizierung und Fehlerbehandlung sowie realistische Beispiele für Anfragen und Antworten im JSON-Format. Neben der schriftlichen Referenz möchten wir eine interaktive Testseite, auf der Partnerentwickler ihre eigenen Schlüssel eingeben, Beispielanfragen senden und live Antworten direkt im Browser sehen können.
Wir können Zugang zu einer Staging-Umgebung, bestehenden internen Notizen und direkter Kommunikation mit unseren Backend-Entwicklern bieten, um knifflige Endpunkte zu klären. Der ideale Kandidat hat praktische Erfahrung mit REST-APIs, JSON, Authentifizierungsschemata wie Tokens oder API-Schlüsseln und Tools zum Erstellen interaktiver Dokumentationen. Bitte teilen Sie Beispiele von Dokumentationen, die Sie zuvor geschrieben haben, sowie einen geschätzten Zeitrahmen.
Liefergegenstände:
— strukturierte Referenz für alle Endpunkte und Parameter
— Beispiele für Anfragen und Antworten für jede Methode
— interaktive Testseite für Partnerentwickler
— kurze Einarbeitungsanleitung für neue Integratoren
Der Job umfasst jeden öffentlichen Endpunkt: klare Beschreibungen dessen, was jede Methode tut, eine vollständige Aufschlüsselung der erforderlichen und optionalen Parameter mit Typen und Standardwerten, Authentifizierung und Fehlerbehandlung sowie realistische Beispiele für Anfragen und Antworten im JSON-Format. Neben der schriftlichen Referenz möchten wir eine interaktive Testseite, auf der Partnerentwickler ihre eigenen Schlüssel eingeben, Beispielanfragen senden und live Antworten direkt im Browser sehen können.
Wir können Zugang zu einer Staging-Umgebung, bestehenden internen Notizen und direkter Kommunikation mit unseren Backend-Entwicklern bieten, um knifflige Endpunkte zu klären. Der ideale Kandidat hat praktische Erfahrung mit REST-APIs, JSON, Authentifizierungsschemata wie Tokens oder API-Schlüsseln und Tools zum Erstellen interaktiver Dokumentationen. Bitte teilen Sie Beispiele von Dokumentationen, die Sie zuvor geschrieben haben, sowie einen geschätzten Zeitrahmen.
Liefergegenstände:
— strukturierte Referenz für alle Endpunkte und Parameter
— Beispiele für Anfragen und Antworten für jede Methode
— interaktive Testseite für Partnerentwickler
— kurze Einarbeitungsanleitung für neue Integratoren
Texte und Übersetzung Bargeld, Banküberweisung
