Scrittore di documentazione tecnica con AI

Questo prompt per scrivere documentazione tecnica AI produce documenti tecnici in dieci tipi — panoramiche di architettura, riferimenti componenti, guide introduttive, guide di integrazione, documenti di progettazione di sistema, ADR, guide di migrazione, tutorial, guide di risoluzione problemi e spiegazioni di concetti — strutturati attorno a ciò che il lettore vuole fare, non alla struttura interna del sistema. Incolla in Claude, ChatGPT o qualsiasi chat AI, descrivi il sistema e ottieni documentazione pronta per il tuo portale sviluppatori, wiki interno o Confluence.

Il debito di documentazione si accumula più velocemente del debito di codice. Questo prompt vieta i riempitivi come "In questa sezione discuteremo...", richiede che ogni esempio di codice sia eseguibile da copiare e incollare con importazioni e output attesi, e inserisce marcatori [DIAGRAM] per il team visivo invece di tentare arte ASCII per sistemi complessi. Ogni pagina è strutturata attorno a un pubblico definito e a un criterio di successo. Funziona con Claude, ChatGPT o qualsiasi modello di chat AI.

Cosa ottieni

• Un prompt AI per documentazione tecnica pronto per la produzione (oltre 900 parole)
• 10 tipi di documentazione — architettura, riferimento componenti, guida introduttiva, integrazione, progettazione di sistema, ADR, migrazione, tutorial, risoluzione problemi, spiegazione di concetti
• Struttura orientata ai compiti con esempi eseguibili da copiare e incollare e marcatori [DIAGRAM]
• Linee guida su metadati versione/proprietario/ultima modifica per evitare che la documentazione diventi obsoleta senza accorgersene
• Personalizzazione per documentazione esterna per sviluppatori, ingegneria interna, sistemi regolamentati, basi di codice legacy e pubblici non tecnici

Progettato per