Dobički:
- Sposobnost varne uporabe umetne inteligence pri izdelavi bele knjige, NatSpec, tehnično preprostega prevajanja in razkritja tveganja ter razumevanje, da je to najbolj produktivno področje.
- Sposobnost preverjanja vsake tehnične trditve z dejansko kodo in odstranitev pretiravanja in garancijskega jezika, da se izognete tveganju nepravilne dokumentacije
- Sposobnost poštenega sprejemanja tveganj, opozorilo 'ne finančnih nasvetov' in skladnost kode dokumentacije
Dokumentacija v Web3 ni razkošje, ampak stvar varnosti in zaupanja. Z interakcijo s pametno pogodbo uporabnik tvega svoj pravi denar; Če ne razume, kaj počne, je odprt za prevaro. Revizor ne more varno pregledati kode, ki ni dobro dokumentirana. V tej enoti pokrivamo področje, kjer je AI najbolj zanesljiv in učinkovit: dokumentacija in tehnično pisanje. Od bele knjige do komentarjev v kodi, od uporabniškega priročnika do razkritij tveganja, umetna inteligenca je tukaj resnični multiplikator moči – dokler se natančnost nadzira človeško.
Vrste dokumentacije Web3
- Whitepaper / litepaper: Osnovni dokument, ki opisuje vizijo, mehanizem in tokenomiko projekta.
- Tehnična dokumentacija: pogodbeni vmesniki, integracijski vodnik za razvijalce.
- NatSpec (Specifikacija naravnega jezika Ethereum — standardni format komentarjev v kodi v Solidityju, ki opisuje, kaj počnejo funkcije): dokumentacija, vdelana v kodo, ki jo berejo tako ljudje kot orodje.
- Uporabniški priročnik: golo besedilo, ki končnemu uporabniku pove, "kako uporabljati, kakšna tveganja obstajajo".
- Zavrnitev odgovornosti: zakonsko in etično zahtevana opozorila.
Pogosta težava pri teh vrstah: razvijalci ne marajo pisati in to pogosto pustijo za zadnji trenutek. AI zapolnjuje točno to vrzel.
Zakaj je dokumentacija najvarnejše področje AI
Cena napake pri dokumentaciji je nižja kot pri reviziji: en napačen stavek se popravi, denar (neposredno) ne leti. Poleg tega je umetna inteligenca naravno močna pri ustvarjanju jezika. Umetna inteligenca je torej tukaj učinkovita in razmeroma varna. Vendar ostajata dve kritični nevarnosti:
- Napačna tehnična trditev: umetna inteligenca lahko napačno predstavi, kaj počne koda; To zavaja uporabnika in lahko postane varnostna ranljivost (razen če piše "ta funkcija ščiti vaša sredstva" in ni).
- Hiperbola/trženjski jezik: umetna inteligenca lahko proizvede jezik, zaradi katerega se projekt zdi varen ali donosen; To je hkrati etični in pravni problem.
Pozor: dokumentacija opisuje kodo; To ni koda sama. Vsako tehnično trditev, ki jo napiše AI ("to se zgodi", "to ohranja"), je treba preveriti glede na dejansko kodo. Napačna dokumentacija je lahko bolj nevarna kot pravilna koda, ker uporabnik zaupa dokumentaciji.
Plasti uporabe AI v dokumentaciji
1. Generacija NatSpec. AI prebere obstoječo funkcijo in pripravi interpretacijo NatSpec: kaj počne, kakšni so njeni parametri, kaj vrne. To poenostavi pregled in vzdrževanje.
2. Tehnično-preprost prevod. Umetna inteligenca prevede zapleten mehanizem v jezik, ki ga lahko razume končni uporabnik – ena največjih potreb Web3.
3. Oris in struktura bele knjige. AI izdela okostje in dele bele knjige; Natančnost vsebine je človeška.
4. Večjezičnost in prilagoditev ravni. Umetna inteligenca lahko ustvari isto vsebino, tako tehnično kot preprosto, v turščini in angleščini.
Šibek poziv/močan poziv
Šibek poziv:
Napišite belo knjigo za ta projekt.
Umetna inteligenca izdela pretirano, morda lažno in marketinško polno kopijo, ne da bi poznala dejanski mehanizem.
Močan poziv:
Vaša vloga: tehnični pisec Web3. Spodaj je mehanizem REAL, tokenomika in koda projekta. Napišite osnutek bele knjige, ki temelji izključno na teh informacijah. Pravila:- Ne pretiravajte, NE uporabljajte besednih zvez, kot so "zajamčen dobiček", "popolnoma varno" itd.- Vsako tehnično trditev temelji na mehanizmu, ki ga dam; Ne dodajajte izmišljotin.– Dodajte razdelek »Tveganja«, ki jasno navaja tveganja.– Dodajte opozorilo »To ni finančni nasvet.« Vse informacije, za katere niste prepričani ali jih nimam, označite kot [TREBA IZPOLNITI].
Štiri predloge za kopiranje
1) Generacija NatSpec:
Napišite standardne komentarje NatSpec za naslednjo funkcijo: @notice (kaj počne, preprosto), @dev (tehnična opomba), @param in @return. Napišite samo to, kar koda DEJANSKO počne; Dodajanje vedenja, ki ga ni v kodi. Označite učinek, za katerega niste prepričani.
2) Tehnično-preprost prevod:
Razložite ta mehanizem v preprostem turškem jeziku, ki ga lahko razume uporabnik kriptovalute začetnik: kaj počne, kaj naj uporabnik naredi, KAKŠNA TVEGANJA obstajajo? pretiravanje; ni jamstva za varnost. Ne skrivajte tveganj, postavite jih v ospredje.
3) Oddelek za tveganje/opozorilo:
Napišite pošten razdelek »Tveganja in opozorila« za ta projekt: tveganje pametne pogodbe, tržno tveganje, likvidnostno tveganje, regulativna negotovost, izguba ključa. Vsako tveganje razložite v preprostem jeziku. Ne podcenjujte tveganj; končajo z "to ni finančni nasvet."
4) Preverjanje skladnosti dokumentacije in kode:
Spodaj je funkcija in njena razpoložljiva dokumentacija. Označite mesta, kjer je dokument v nasprotju z DEJANSKIM obnašanjem kode ali ga izpušča. Končno odločanje; Pošljite ga v "preverjanje razvijalca".
Trije mini kovčki (v številkah)
1. primer – NatSpec je okrepil pregled. Ena ekipa je brez pripomb predložila pogodbo za 25 funkcij v pregled; Revizor je prosil za dodatni čas, da bi razumel logiko. Ekipa je izdelala osnutke NatSpec z AI in vsakega potrdila s kodo; Priprava revizije je bila skrajšana za skoraj 1 dan. Nauk: dobra dokumentacija zmanjša stroške revizije.
Primer 2 – Ulovljena lažna trditev. V uporabniškem priročniku, ki ga je izdelal YZ, je navedeno, da se »vaša sredstva lahko dvignejo kadar koli«; medtem ko je bila pogodba zaklenjena na 7 dni. Tehnični pregled je to ugotovil. Če bi bil objavljen, bi bili uporabniki v zmoti in žrtev. Nauk: vsaka tehnična trditev je potrjena s kodo.
Primer 3 – Pretiravanje odpravljeno. V prvem osnutku bele knjige je AI uporabil izraze, kot je "visok donos brez tveganja". Ekipa jih je odstranila in dodala razdelek o poštenem tveganju. To je zaščitilo projekt tako etično kot pravno. Lekcija: trženjsko pristranskost AI je treba pregledati.
Etično breme dokumentacije
Dokumentacija Web3 se bere v kontekstu, kjer uporabnik tvega svoj denar. Zato:
- Iskrenost: Tveganja ni mogoče skriti in ni mogoče dati pretiranih obljub.
- Točnost: Tehnične trditve se morajo ujemati s kodo; "V dokumentu tako piše" ni obramba, temveč lažna navedba.
- Dostopnost: Pisanje v jeziku, ki ga uporabnik dejansko razume, je varnostni ukrep; Dokument, ki ga ne razumemo, je povabilo k prevari.
- Zavrnitev odgovornosti: Jasno je treba povedati, da ne gre za finančno svetovanje in regulativno negotovost.
Namig: Preizkus poštenosti dokumenta Web3: "Če uporabnik vloži denar v zaupanje samo temu dokumentu, ali se bo ob soočenju z resnico počutil prevaranega?" Vedno naj AI poudari tvegani del, ne pa da ga zakoplje na koncu.
Pogoste napake
- Tehnična trditev ni potrjena s kodo. Napačen dokument zavaja uporabnika.
- Opustitev hype/marketinškega jezika. Etično in pravno tveganje.
- Zmanjšanje ali skrivanje tveganj. Zloraba zaupanja.
- Tiskanje bele knjige, ne da bi umetni inteligenci posredovali pravi mehanizem. Proizvaja izmišljotine.
- Ignoriranje opozorila "ni finančni nasvet". Zakonska obveznost.
- Dokumentacija ni usklajena s kodo. Ko se koda spremeni, dokument postane zavajajoč.
Če povzamem
- Dokumentacija je stvar varnosti in zaupanja v Web3; Je najbolj produktivno področje AI.
- Cena napake je razmeroma nizka, vendar so napačne tehnične trditve in pretiravanje resna tveganja.
- Vsaka tehnična trditev mora biti potrjena z resnično kodo; Dokument ne nadomešča šifre.
- Tveganja morajo biti napisana pošteno in vidno; Odstraniti je treba jezik pretiravanja in jamstva.
- "To ni finančni nasvet" in regulativna opozorila so obvezna.
Aplikacijska naloga
Pridobite funkcijo pametne pogodbe. Umetni inteligenci dajte poziv »Generate NatSpec« in primerjajte ustvarjeno interpretacijo vrstico za vrstico z dejanskim obnašanjem kode – ali obstajajo nesoglasja? Nato izdelajte "tehnično preprost prevod" in "razdelek o tveganju/opozorilu" za isto funkcijo. Poiščite in popravite vsaj eno izjavo AI, ki je pretirana ali je v nasprotju s kodo.
kontrolni seznam
- [ ] Vsak tehnični zahtevek sem potrdil z dejansko kodo.
- [ ] Odstranil sem pretiravanja/garancije.
- [ ] Tveganja sem napisal pošteno in jih poudaril.
- [ ] AI sem dal pravi mehanizem; Nisem mu dovolil, da si je izmislil.
- [ ] Dodal sem opozorilo "To ni finančni nasvet."
- [ ] V celoti sem napisal NatSpec za vozilo in nadzor.
- [ ] Načrtoval sem, da bom dokumentacijo sinhroniziral s kodo.