Scriitor AI pentru documentație tehnică

Acest prompt AI pentru redactarea documentației tehnice produce documentație tehnică în zece tipuri — prezentări de arhitectură, referințe de componente, ghiduri de început, ghiduri de integrare, documentație de design sistem, ADR-uri, ghiduri de migrare, tutoriale, ghiduri de depanare și explicatoare de concepte — structurate în funcție de ceea ce încearcă cititorul să facă, nu de structura internă a sistemului. Lipește în Claude, ChatGPT sau orice AI de chat, descrie sistemul și obține documentație gata pentru portalul tău de dezvoltatori, wiki intern sau Confluence.

Datoria de documentație se acumulează mai rapid decât datoria de cod. Acest prompt interzice expresiile de umplutură de genul „În această secțiune vom discuta...”, cere ca fiecare exemplu de cod să fie rulabil prin copy-paste cu importuri și output așteptat și plasează marcatori [DIAGRAM] pentru echipa vizuală, în loc să încerce artă ASCII pentru sisteme complexe. Fiecare pagină este structurată în jurul unui public țintă și a unui criteriu de succes. Funcționează cu Claude, ChatGPT sau orice model AI de chat.

Ce primești

• Un prompt AI pentru documentație tehnică gata de producție (peste 900 de cuvinte)
• 10 tipuri de documentație — arhitectură, referință componentă, ghid de început, integrare, design sistem, ADR, migrare, tutorial, depanare, explicator de concepte
• Structură orientată pe sarcini cu exemple rulabile copy-paste și marcatori [DIAGRAM]
• Ghid pentru metadatele versiune/proprietar/ultima actualizare pentru a preveni ca documentația să devină învechită fără să fie observată
• Personalizare pentru documentație externă pentru dezvoltatori, inginerie internă, sisteme reglementate, baze de cod vechi și audiențe non-tehnice

Creat pentru