Tagagawa ng Teknikal na Dokumentasyon
Para sa mga inhinyero at teknikal na manunulat na nangangailangan ng tumpak at madaling mapanatiling dokumento mula sa umiiral na codebase o espesipikasyon.
Best for these models
๐ The Prompt
๐ Available ang prompt sa download
Kunin ang buong prompt text sa downloadable na .txt file. Libre, walang signup na kailangan.
I-download PromptVariables to fill in
{{SOURCE_MATERIAL}} โ Replace with your input {{AUDIENCE}} โ Replace with your input {{DEPTH}} โ Replace with your input {{ENVIRONMENT}} โ Replace with your input {{CONSTRAINTS}} โ Replace with your input About this prompt
Ang teknikal na dokumentasyon na template na ito ay naglilipat ng magkahalong tala ng code, inline comments, at detalye ng implementasyon sa isang malinis at nakaayos na dokumento. Ito ay perpekto kapag kailangan mo ng pare-parehong output para sa mga overview ng arkitektura, hakbang sa setup, pag-uugali ng endpoint, at edge cases nang hindi kailangang isulat muli ang parehong konteksto nang mano-mano. Ang prompt ay gumagabay sa modelo upang paghiwalayin ang factual na pag-uugali mula sa mga palagay, na tumutulong upang mabawasan ang hallucinations at mapanatili ang dokumento na naka-align sa aktwal na codebase.
Partikular na kapaki-pakinabang ito para sa mga backend na inhinyero, tagapagtaguyod ng developer, at mga teknikal na manunulat na nagdodokumento ng mga serbisyo pagkatapos ng pagpapalabas ng feature o habang nasa maintenance. Ang output ay inayos upang madaling mahanap ng mga mambabasa ang mga prerequisites, configuration, mga halimbawa, at mga caveat. Maaari mong iangkop ang tono para sa mga internal wiki, mga gabay para sa customer, o mga handoff notes sa pamamagitan ng pagbabago ng audience at voice variables. Maganda rin itong gamitin kasabay ng release notes, dahil maaaring ibuod ng modelo kung ano ang nagbago at bakit ito mahalaga.
Para i-customize, i-paste ang iyong source material sa {{SOURCE_MATERIAL}}, tukuyin ang audience sa {{AUDIENCE}}, at itakda ang nais na lalim sa {{DEPTH}}. Kung nais mo ng mas maraming detalye sa operasyon, idagdag ang {{ENVIRONMENT}} at {{CONSTRAINTS}} upang maisama ng modelo ang mga deployment notes, dependencies, at limitasyon. Ang inaasahang output ay isang polished na dokumento na may mga heading, maiikling talata, at mga halimbawa. Para sa pinakamahusay na resulta, humingi ng isang pagdaan na nakatuon sa katumpakan, at isang pangalawang pagdaan na nakatuon sa readability at estruktura.
Key features
- Nakaayos na dokumento na may mga seksyon para sa overview, setup, paggamit, at mga tala
- Pinoprotektahan ang katumpakan sa pamamagitan ng paghihiwalay ng mga facts mula sa mga palagay
- Madaling iangkop sa internal wikis o mga gabay para sa customer
- Kasama ang configurable na lalim para sa mabilis o detalyadong dokumentasyon
- Maganda para sa codebase summaries at mga handoff notes
Best for
- โ Mga backend na inhinyero na nagdodokumento ng mga bagong serbisyo pagkatapos ng paglulunsad
- โ Mga tagapagtaguyod ng developer na naghahanda ng internal at external na mga gabay
- โ Mga teknikal na manunulat na nagko-convert ng mga tala ng engineering sa polished na dokumento
Tips
- ๐ก Magbigay ng mga code snippets at config files upang mapabuti ang factual na katumpakan.
- ๐ก Itakda ang DEPTH sa 'brief' para sa mga handoff o 'detailed' para sa mga release na dokumento.
- ๐ก Idagdag ang CONSTRAINTS para sa mga limitasyon ng platform, mga patakaran sa authentication, o mga nota sa pagsunod.
What you'll get
Isang kumpletong draft ng dokumentasyon na may malinaw na mga heading, maigting na paliwanag, praktikal na mga halimbawa, at isang maikling seksyon ng mga tala na sumasaklaw sa mga palagay, dependencies, at mga caveat. Ang resulta ay parang isang handang i-publish na knowledge base article o karagdagan sa README.
Preparing your download...
I-download PromptKaugnay na prompts
Tagasuri ng Kontrata ng API
Para sa mga inhinyero na nagsusuri ng mga pagbabago sa API na maaaring makasira sa mga kliyente, kontrata, o mga garantiya sa backward compatibility.
API Mock Server Blueprinter
Para sa mga koponan na bumubuo ng mga mock na serbisyo na nagsusimulate ng makatotohanang pag-uugali ng API bago matapos ang backend.
API Reference Documentation Forge
Para sa mga koponan ng platform na gumagawa ng tumpak na API reference docs mula sa schemas, routes, o endpoint notes.
Arkitekto ng Backend Test Fixture
Para sa mga senior engineer na gumagawa ng reusable fixtures at mocks para sa mga komplikadong backend test suite.