Cercasi uno scrittore tecnico per documentare la nostra API

La nostra azienda ha costruito un'API REST che gli sviluppatori partner utilizzano per integrarsi con la nostra piattaforma, ma la documentazione attuale è obsoleta e dispersa tra wiki interni e vecchie foglie di calcolo. Stiamo cercando uno scrittore tecnico esperto che possa trasformare i nostri endpoint esistenti in un riferimento pulito e strutturato su cui gli sviluppatori possano fare affidamento senza dover contattare il nostro team di supporto ogni volta che si bloccano.

Il lavoro copre ogni endpoint pubblico: descrizioni chiare di cosa fa ciascun metodo, una suddivisione completa dei parametri richiesti e facoltativi con tipi e valori predefiniti, gestione dell'autenticazione e degli errori, e esempi realistici di richiesta e risposta in JSON. Oltre al riferimento scritto, vogliamo una pagina di test interattiva dove gli sviluppatori partner possono inserire le proprie chiavi, inviare richieste di esempio e vedere risposte in tempo reale direttamente nel browser.

Possiamo fornire accesso a un ambiente di staging, note interne esistenti e comunicazione diretta con i nostri sviluppatori backend per chiarire endpoint complicati. Il candidato ideale ha esperienza pratica con API REST, JSON, schemi di autenticazione come token o chiavi API, e strumenti per costruire documenti interattivi. Si prega di condividere esempi di documentazione che hai scritto in precedenza, insieme a una tempistica stimata.

Consegne:
— riferimento strutturato per tutti gli endpoint e parametri
— esempi di richiesta e risposta per ciascun metodo
— pagina di test interattiva per gli sviluppatori partner
— breve guida di onboarding per nuovi integratori