Utveckling ·

Dokumentera kod med AI utan falska löften

AI kan snabbt föreslå en README eller API-beskrivning, men den vet inte automatiskt hur tjänsten körs i produktion.

Ge både kod och körväg

Förklara vem som ska läsa dokumentet och vilka kommandon som verkligen används. Be AI skriva förutsättningar, ett minsta fungerande exempel, vanliga fel och hur man verifierar resultatet. Märk steg som kräver hemligheter med variabelnamn, aldrig riktiga värden.

Prova instruktionen från början

Låt en kollega följa texten i en ren miljö. Fungerar inte stegen, rätta dokumentet och gärna den underliggande installationen. Kontrollera att AI inte hittat på flaggor eller endpoints. Dokumentation är färdig när någon annan kan använda den, inte när den ser komplett ut.

Prova själv

Testa varje kommando i dokumentationen innan du publicerar det.

Källa och vidare läsning

GitHub Docs: Responsible use of Copilot Chat

Fler artiklar om AI