Mga nadagdag:
- Ang pagiging ligtas na gumamit ng artificial intelligence sa paggawa ng whitepaper, NatSpec, teknikal-simpleng pagsasalin at pagsisiwalat ng panganib at pag-unawa na ito ang pinakaproduktibong larangan.
- Kakayahang i-verify ang bawat teknikal na claim gamit ang aktwal na code at alisin ang pagmamalabis at wika ng warranty upang maiwasan ang panganib ng maling dokumentasyon
- Kakayahang tanggapin ang mga panganib nang matapat, 'hindi payo sa pananalapi' na babala at pagkakapare-pareho ng code ng dokumentasyon
Ang dokumentasyon sa Web3 ay hindi isang luho, ngunit isang bagay ng seguridad at tiwala. Sa pamamagitan ng pakikipag-ugnayan sa isang matalinong kontrata, isinasapanganib ng user ang kanyang tunay na pera; Kung hindi niya maintindihan ang kanyang ginagawa, bukas siya sa panloloko. Hindi ligtas na marerepaso ng auditor ang code na hindi mahusay na dokumentado. Sa yunit na ito, sinasaklaw namin ang lugar kung saan ang AI ay pinaka maaasahan at mahusay: dokumentasyon at teknikal na pagsulat. Mula sa whitepaper hanggang sa mga in-code na komento, mula sa gabay ng gumagamit hanggang sa mga pagsisiwalat sa panganib, ang AI ay isang tunay na force multiplier dito — hangga't ang katumpakan ay makataong sinusubaybayan.
Mga uri ng dokumentasyon sa Web3
- Whitepaper / litepaper: Ang pangunahing dokumento na naglalarawan sa pananaw, mekanismo at tokenomics ng proyekto.
- Teknikal na dokumentasyon: Mga interface ng kontrata, gabay sa pagsasama para sa mga developer.
- NatSpec (Ethereum Natural Language Specification — Standard in-code na format ng komento sa Solidity na naglalarawan kung ano ang ginagawa ng mga function): Documentation na naka-embed sa code, binasa ng tao at tool.
- Gabay sa gumagamit: Plain text na nagsasabi sa end user na "paano gamitin, anong mga panganib ang mayroon".
- Disclaimer: Mga babala na kinakailangan ayon sa batas at etika.
Isang karaniwang problema sa mga ganitong uri: ang mga developer ay hindi gustong magsulat at madalas na iwanan ito sa huling sandali. Eksaktong pinupunan ng AI ang puwang na ito.
Bakit ang dokumentasyon ang pinakaligtas na lugar ng AI
Ang halaga ng error sa dokumentasyon ay mas mababa kaysa sa pag-audit: isang maling pangungusap ay naitama, walang pera na lumilipad (direkta). Bukod pa rito, natural na malakas ang AI sa paggawa ng wika. Kaya ang AI ay parehong mahusay at medyo ligtas dito. Ngunit dalawang kritikal na panganib ang nananatili:
- Maling teknikal na pag-aangkin: Maaaring misrepresent ng AI kung ano ang ginagawa ng code; Nililinlang nito ang user at maaaring maging isang kahinaan sa seguridad (maliban kung sinasabi nitong "pinoprotektahan ng function na ito ang iyong mga pondo" at hindi).
- Hyperbole/marketing language: Maaaring gumawa ang AI ng wika na ginagawang mukhang ligtas o kumikita ang isang proyekto; Ito ay parehong etikal at legal na problema.
Babala: Inilalarawan ng dokumentasyon ang code; Hindi ito ang code mismo. Ang bawat teknikal na pahayag na isinulat ng AI ("ito ay nangyayari", "na nagpapanatili") ay dapat na ma-verify laban sa aktwal na code. Maaaring mas mapanganib ang maling dokumentasyon kaysa sa tamang code dahil pinagkakatiwalaan ng user ang dokumentasyon.
Mga layer ng paggamit ng AI sa dokumentasyon
1. henerasyon ng NatSpec. Binabasa ng AI ang isang umiiral na function at binabalangkas ang interpretasyon ng NatSpec: kung ano ang ginagawa nito, kung ano ang mga parameter nito, kung ano ang ibinabalik nito. Pinapasimple nito ang inspeksyon at pagpapanatili.
2. Teknikal-simpleng pagsasalin. Isinasalin ng AI ang isang kumplikadong mekanismo sa wika na mauunawaan ng end user — isa sa mga pinakamalaking pangangailangan ng Web3.
3. Whitepaper outline at istraktura. Ang AI ay gumagawa ng balangkas at mga seksyon ng isang whitepaper; Ang katumpakan ng nilalaman ay pantao.
4. Multilingualism at pagsasaayos ng antas. Ang AI ay maaaring gumawa ng parehong nilalaman, parehong teknikal at payak, sa parehong Turkish at English.
Mahinang prompt / Malakas na prompt
Mahinang prompt:
Sumulat ng whitepaper para sa proyektong ito.
Ang AI ay bumubuo ng pinalaking, posibleng hindi totoo, at puno ng marketing na kopya nang hindi nalalaman ang aktwal na mekanismo.
Napakahusay na prompt:
Ang iyong tungkulin: Web3 teknikal na manunulat. Nasa ibaba ang TUNAY na mekanismo, tokenomics at code ng proyekto. Sumulat ng draft ng isang whitepaper batay lamang sa impormasyong ito. Mga Panuntunan:- Huwag palakihin, HUWAG gumamit ng mga parirala tulad ng "garantisadong kita", "ganap na ligtas" atbp.- Ibase ang bawat teknikal na paghahabol sa mekanismong ibinibigay ko; Huwag magdagdag ng katha.- Magdagdag ng seksyong "Mga Panganib" na malinaw na nagsasaad ng mga panganib.- Magdagdag ng babala "Hindi ito payo sa pananalapi." Markahan ang anumang impormasyong hindi ka sigurado o wala ako bilang [TO BE FILLED].
Apat na maaaring kopyahin na mga template
1) henerasyon ng NatSpec:
Sumulat ng mga karaniwang komento ng NatSpec sa sumusunod na function: @notice (what does, plain), @dev (technical note), @param at @return. Isulat lamang kung ano ang TOTOONG ginagawa ng code; Pagdaragdag ng gawi na wala sa code. I-flag ang epekto na hindi ka sigurado.
2) Teknikal-simpleng pagsasalin:
Ipaliwanag ang mekanismong ito sa simpleng Turkish na mauunawaan ng isang baguhan na gumagamit ng crypto: ano ang ginagawa nito, ano ang dapat gawin ng gumagamit, ANONG MGA PANGANIB ang nariyan? Pagmamalabis; walang garantiya ng seguridad. Huwag itago ang mga panganib, dalhin ang mga ito sa unahan.
3) Seksyon ng panganib/babala:
Sumulat ng isang tapat na seksyong "Mga Panganib at Caveats" para sa proyektong ito: panganib sa smartcontract, panganib sa merkado, panganib sa pagkatubig, kawalan ng katiyakan sa regulasyon, pangunahing pagkawala. Ipaliwanag ang bawat panganib sa simpleng wika. Huwag maliitin ang mga panganib; magtatapos sa "ito ay hindi payo sa pananalapi."
4) Pagsusuri ng pagkakapare-pareho ng code ng dokumentasyon:
Nasa ibaba ang isang function at ang available na dokumentasyon nito. Markahan ang mga lugar kung saan ang dokumento ay sumasalungat o nag-aalis sa ACTUAL na pag-uugali ng code. Pangwakas na paggawa ng desisyon; Isumite ito para sa "pag-verify ng developer".
Tatlong mini case (sa mga numero)
Kaso 1 — Pinalakas ng NatSpec ang inspeksyon. Isang koponan ang nagsumite ng 25-function na kontrata para sa pagsusuri nang walang komento; Humingi ang auditor ng dagdag na oras upang maunawaan ang lohika. Ang koponan ay gumawa ng mga draft ng NatSpec na may AI at kinumpirma ang bawat isa gamit ang code; Ang paghahanda sa pag-audit ay pinaikli ng halos 1 araw. Aralin: ang mahusay na dokumentasyon ay nakakabawas ng gastos sa pag-audit.
Kaso 2 — Nahuli ang maling claim. Ang user manual na ginawa ng YZ ay nakasaad na "ang iyong mga pondo ay maaaring bawiin anumang oras"; samantalang mayroong 7-araw na lock sa kontrata. Nahuli ito ng teknikal na pagsusuri. Kung ito ay nai-publish, ang mga gumagamit ay magkakamali at mabibiktima. Aralin: bawat teknikal na paghahabol ay kinumpirma ng code.
Kaso 3 — Naalis ang pagmamalabis. Sa unang whitepaper draft, gumamit ang AI ng mga expression gaya ng "high return without risk". Inalis ng team ang mga ito at nagdagdag ng isang matapat na seksyon ng panganib. Pinoprotektahan nito ang proyekto sa parehong etikal at legal. Aralin: Dapat i-audit ang bias sa marketing ng AI.
Etikal na pasanin ng dokumentasyon
Ang dokumentasyon sa Web3 ay binabasa sa isang konteksto kung saan ang gumagamit ay nanganganib sa kanilang pera. Samakatuwid:
- Katapatan: Ang mga panganib ay hindi maaaring itago at ang mga pinalaking pangako ay hindi maaaring gawin.
- Katumpakan: Ang mga teknikal na paghahabol ay dapat tumugma sa code; "Ang sabi ng dokumento" ay hindi isang pagtatanggol, ngunit sa halip ay isang maling representasyon.
- Accessibility: Ang pagsulat sa wikang talagang nauunawaan ng user ay isang hakbang sa seguridad; Ang isang dokumento na hindi naiintindihan ay isang imbitasyon sa panlilinlang.
- Disclaimer: Dapat itong malinaw na nakasaad na hindi ito payo sa pananalapi at kawalan ng katiyakan sa regulasyon.
Tip: Pagsusuri ng katapatan ng isang dokumento sa Web3: "Kung ang isang user ay naglalagay ng pera sa pagtitiwala lamang sa dokumentong ito, madarama ba niya na nalinlang siya kapag nahaharap sa katotohanan?" Palaging i-highlight ng AI ang bahagi ng panganib, huwag ilibing ito sa dulo.
Mga karaniwang pagkakamali
- Hindi kinukumpirma ang teknikal na claim gamit ang code. Ang maling dokumento ay nanlilinlang sa gumagamit.
- Ibinaba ang hype/marketing language. Etikal at legal na panganib.
- Pagbabawas o pagtatago ng mga panganib. Pagsira ng tiwala.
- Pagpi-print ng whitepaper nang hindi ibinibigay ang tunay na mekanismo sa AI. Gumagawa ito ng mga katha.
- Hindi pinapansin ang babala na "hindi payo sa pananalapi". Legal na obligasyon.
- Hindi pinapanatili ang dokumentasyon na naka-sync sa code. Kapag nagbago ang code, nagiging mapanlinlang ang dokumento.
Sa buod
- Ang dokumentasyon ay isang bagay ng seguridad at pagtitiwala sa Web3; Ito ang pinaka-produktibong larangan ng AI.
- Ang halaga ng error ay medyo mababa, ngunit ang mga maling teknikal na paghahabol at pagmamalabis ay mga seryosong panganib.
- Ang bawat teknikal na paghahabol ay dapat kumpirmahin ng tunay na code; Hindi pinapalitan ng dokumento ang code.
- Ang mga panganib ay dapat isulat nang tapat at kitang-kita; Ang pananalitang pagmamalabis at garantiya ay dapat alisin.
- "Hindi ito payo sa pananalapi" at ang mga babala sa regulasyon ay sapilitan.
Gawain ng aplikasyon
Kumuha ng function ng matalinong kontrata. Bigyan ang AI ng prompt na "Bumuo ng NatSpec" at ihambing ang nabuong interpretasyon na linya sa pamamagitan ng linya sa aktwal na pag-uugali ng code - mayroon bang anumang hindi pagkakasundo? Pagkatapos ay gumawa ng "teknikal-plain na pagsasalin" at isang "seksyon ng panganib/babala" para sa parehong function. Maghanap at iwasto ang kahit isang pahayag ng AI na pinalaki o sumasalungat sa code.
checklist
- [ ] Kinumpirma ko ang bawat teknikal na paghahabol na may aktwal na code.
- [ ] Inalis ko ang mga pagmamalabis/garantiya.
- [ ] Isinulat ko nang tapat ang mga panganib at itinatampok ang mga ito.
- [ ] Ibinigay ko sa AI ang tunay na mekanismo; Hindi ko siya hinayaang gumawa.
- [ ] Idinagdag ko ang babala na "Hindi ito payo sa pananalapi."
- [ ] Isinulat ko ang NatSpec nang buo para sa sasakyan at kontrol.
- [ ] Pinlano kong panatilihing naka-sync ang dokumentasyon sa code.