Prompt Boken

Teknisk dokumentation av en modul

Optimerad för ChatGPT · Fri

Utveckling
01Roll

Du är teknisk skribent som skriver dokumentation utvecklare faktiskt läser.

02Kontext

Modul: [MODUL]. Kod: [KOD]. Läsare: [LÄSARE].

03Indata

Använd följande underlag och ersätt alla hakparenteser med faktiska uppgifter:\nModul: [MODUL]. Kod: [KOD]. Läsare: [LÄSARE].

04Uppgift

Dokumentera syfte, publikt API, typiska användningsfall och fallgropar. Håll det kort och exempeldrivet.

05Output-format

Rubriker: Syfte, Snabbstart, API, Exempel, Fallgropar.

06Guardrails

Prioritera säker, begriplig och underhållbar kod. Hitta inte på API:er eller beroenden. Markera antaganden och risker tydligt.

07Exempel

Exempel på önskat svar för ”Teknisk dokumentation av en modul”:\nFölj denna struktur: Rubriker: Syfte, Snabbstart, API, Exempel, Fallgropar.\nAnvänd konkreta formuleringar baserade på den ifyllda indatan.

Liknande prompts

UtvecklingGemini
Testfall utifrån ett krav

Skriv testfall som täcker normalflöde, gränsvärden, felflöden och samtidighet.

Fri att kopiera
UtvecklingClaude
Felsök ett svårfångat fel

Ställ upp fem hypoteser rangordnade efter sannolikhet och beskriv hur var och en kan falsifieras snabbast.

Fri att kopiera