DEVELOPER
Una documentazione tecnica è utile quando permette a un'altra persona di capire come usare davvero una funzione o un'API. BestPrompt ti aiuta a preparare un prompt che chieda descrizioni accurate, parametri, casi d'uso ed esempi basati sul codice o sul contratto API effettivamente disponibile, senza inventare endpoint e comportamenti.
Indica pubblico, codice disponibile e formato della documentazione.
Prompt per README di moduli, descrizioni di metodi, guide di integrazione e pagine di riferimento API. L'applicazione non ispeziona automaticamente il tuo repository e non produce documentazione autorevole senza una fonte tecnica.
Documentare una funzione per un collega che conosce il progetto è diverso dal descrivere un'API pubblica. Definisci destinatario, livello tecnico e risultato che il lettore deve raggiungere. Raccogli firme, parametri reali, valori restituiti, esempi validi, errori conosciuti e prerequisiti. Se stai documentando un endpoint, chiarisci metodo HTTP, autorizzazione necessaria e formati supportati senza inserire token reali.
Fornisci all'assistente AI il prompt e soltanto i frammenti di codice o lo schema API necessari. Chiedi sezioni brevi: scopo, input, output, esempio di richiesta, esempio di risposta ed errori. Per documentazione interna puoi preferire Markdown e tabelle; per interfacce API puoi chiedere una proposta OpenAPI, da confrontare con l'implementazione. Non lasciare che l'AI inventi endpoint, codici di stato o parametri assenti dal materiale.
Segui le istruzioni dall'inizio usando un ambiente di test. Controlla che gli esempi siano eseguibili, che nomi e tipi corrispondano al codice e che siano indicate le versioni. Chiedi all'AI di individuare frasi ambigue come 'configura correttamente il server' e sostituirle con prerequisiti verificabili. La documentazione migliore riduce le domande di chi integra il sistema.
Oscura chiavi, URL interni e informazioni operative sensibili. Verifica autorizzazioni prima di pubblicare documentazione tecnica. Un testo generato dall'AI non certifica la compatibilità dell'API né sostituisce test di integrazione.
Per aiutare a spiegare file e simboli del codice in un IDE compatibile.
Verifica ogni firma, parametro e esempio su API effettive.
Esempio non esclusivo; nessuna integrazione, affiliazione o garanzia
Sito ufficiale GitHub Copilot (si apre in una nuova scheda)Per riorganizzare una bozza di documentazione destinata agli integratori.
Chiedi di segnalare le informazioni non presenti nel materiale.
Esempio non esclusivo; nessuna integrazione, affiliazione o garanzia
Sito ufficiale Claude (si apre in una nuova scheda)Richiesta iniziale (illustrativa): «Devo documentare per i colleghi l'endpoint GET /api/orders/{id} di un gestionale, ma prima voglio un formato che non inventi campi o risposte».
Che cosa deve chiarire il prompt: contratto effettivo, requisiti di accesso, parametri, esempi verificati e segnalazione delle informazioni mancanti.
Agisci come technical writer per un'API REST interna. Devo creare una scheda Markdown per l'endpoint GET /api/orders/{id}. Usa esclusivamente il codice, gli esempi di risposta e le regole di autorizzazione che ti fornirò. Organizza la scheda in scopo, metodo e percorso, autenticazione, parametri, esempio di richiesta, struttura della risposta, errori documentati e note di utilizzo. Non inventare codici HTTP, proprietà JSON, parametri o permessi. Se una sezione non è ricavabile dal materiale, scrivi «Da verificare nel progetto» e indica quale file o specifica servirebbe. Restituisci il Markdown finale senza introdurre API alternative.
Gli esempi sono illustrativi. Copia il prompt in un servizio AI esterno; verifica i dati e il risultato.
Sì. Indica il livello del pubblico e chiedi esempi mirati ai flussi più comuni.
Non necessariamente: possono bastare codice e risposte effettive, purché si distinguano i fatti verificati dalle informazioni mancanti.
Può farlo se le istruzioni sono vaghe. Il prompt dovrebbe imporre l'uso di fonti reali e la segnalazione esplicita delle lacune.
