Jedinica 8 / 11

Dokumentacija i tehničko pisanje: Whitepaper, NatSpec i Korisničko uputstvo

Dobici:

  • Mogućnost sigurnog korištenja umjetne inteligencije u izradi bijelog papira, NatSpec-a, tehnički jednostavnog prijevoda i otkrivanja rizika i razumijevanja da je ovo najproduktivnije polje.
  • Mogućnost provjere svake tehničke tvrdnje sa stvarnim kodom i uklanjanja preuveličavanja i jezika garancije kako bi se izbjegao rizik od netačne dokumentacije
  • Sposobnost iskrenog prihvatanja rizika, upozorenje 'ne finansijski savjet' i konzistentnost koda dokumentacije

Dokumentacija u Web3 nije luksuz, već stvar sigurnosti i povjerenja. Interakcijom sa pametnim ugovorom, korisnik rizikuje svoj pravi novac; Ako ne razumije šta radi, spreman je da bude prevaren. Revizor ne može bezbedno pregledati kod koji nije dobro dokumentovan. U ovoj jedinici pokrivamo oblast u kojoj je AI najpouzdaniji i najefikasniji: dokumentacija i tehničko pisanje. Od bijelog papira do komentara u kodu, od korisničkog vodiča do otkrivanja rizika, AI je ovdje pravi multiplikator sile – sve dok se preciznost humano prati.

Vrste Web3 dokumentacije

  • Whitepaper / litepaper: Osnovni dokument koji opisuje viziju, mehanizam i tokenomiju projekta.
  • Tehnička dokumentacija: Ugovorni interfejsi, vodič za integraciju za programere.
  • NatSpec (Specifikacija prirodnog jezika Ethereum — Standardni format komentara u kodu u Solidity-u koji opisuje šta funkcije rade): dokumentacija ugrađena u kod, čitaju je i ljudi i alati.
  • Uputstvo za upotrebu: Običan tekst koji govori krajnjem korisniku "kako koristiti, koji rizici postoje".
  • Odricanje od odgovornosti: Zakonski i etički obavezna upozorenja.

Čest problem kod ovih tipova: programeri ne vole pisati i često to ostavljaju za posljednji trenutak. AI upravo popunjava ovu prazninu.

Zašto je dokumentacija najsigurnije područje AI

Cena greške u dokumentaciji je niža nego u reviziji: jedna netačna rečenica je ispravljena, novac ne leti (direktno). Osim toga, AI je prirodno jaka u proizvodnji jezika. Dakle, AI je ovdje i efikasan i relativno siguran. Ali ostaju dva kritična rizika:

  1. Lažna tehnička tvrdnja: AI može pogrešno predstaviti šta kod radi; Ovo dovodi korisnika u zabludu i može postati sigurnosna ranjivost (osim ako ne piše "ova funkcija štiti vaša sredstva", a ne).
  2. Hiperbola/marketinški jezik: AI može proizvesti jezik koji čini projekat sigurnim ili profitabilnim; Ovo je i etički i pravni problem.
Oprez: Dokumentacija opisuje kod; To nije sam kod. Svaka tehnička tvrdnja koju AI zapiše („ovo se dešava“, „koje održava“) mora biti verifikovana u odnosu na stvarni kod. Neispravna dokumentacija može biti opasnija od ispravnog koda jer korisnik vjeruje dokumentaciji.

Slojevi korištenja AI u dokumentaciji

1. NatSpec generacija. AI čita postojeću funkciju i izrađuje NatSpec interpretaciju: šta radi, koji su njeni parametri, šta vraća. Ovo pojednostavljuje pregled i održavanje.

2. Tehnički-jednostavan prijevod. AI prevodi složeni mehanizam na jezik koji krajnji korisnik može razumjeti – što je jedna od najvećih potreba Web3.

3. Pregled i struktura bijelog papira. AI proizvodi kostur i dijelove bijelog papira; Tačnost sadržaja je ljudska.

4. Višejezičnost i prilagođavanje nivoa. AI može proizvesti isti sadržaj, tehnički i jednostavan, na turskom i engleskom jeziku.

Slaba prompt / Jaka prompt

Slab upit:

Napišite bijelu knjigu za ovaj projekat.

AI izmišlja pretjeranu, možda lažnu i marketinški ispunjenu kopiju bez poznavanja stvarnog mehanizma.

Snažan upit:

Vaša uloga: Web3 tehnički pisac. Ispod je PRAVI mehanizam, tokenomika i kod projekta. Napišite nacrt bijelog papira isključivo na osnovu ovih informacija. Pravila: - Ne preterujte, NE koristite fraze kao što su "zagarantovan profit", "potpuno bezbedan" itd. - Zasnovajte svaku tehničku tvrdnju na mehanizmu koji dajem; Nemojte dodavati izmišljotine.- Dodajte odjeljak "Rizici" koji jasno navodi rizike.- Dodajte upozorenje "Ovo nije finansijski savjet." Označite sve informacije za koje niste sigurni ili koje ja nemam kao [TO BE FILLED].

Četiri šablona za kopiranje

1) NatSpec generacija:

Napišite standardne NatSpec komentare na sljedeću funkciju: @notice (šta radi, obično), @dev (tehnička napomena), @param i @return. Napišite samo ono što kod STVARNO radi; Dodavanje ponašanja koje nije u kodu. Označite efekat za koji niste sigurni.

2) Tehnički-jednostavan prijevod:

Objasnite ovaj mehanizam na jednostavnom turskom jeziku koji kripto korisnik početnik može razumjeti: šta radi, šta korisnik treba da radi, KOJI RIZICI postoje? Preterivanje; nema garancije sigurnosti. Ne skrivajte rizike, izvucite ih u prvi plan.

3) Odjeljak za rizik/upozorenje:

Napišite iskren odjeljak "Rizici i upozorenja" za ovaj projekat: rizik pametnog ugovora, tržišni rizik, rizik likvidnosti, regulatorna nesigurnost, ključni gubitak. Objasnite svaki rizik jednostavnim jezikom. Ne potcenjujte rizike; završiti sa "ovo nije finansijski savjet."

4) Provjera konzistentnosti koda dokumentacije:

Ispod je funkcija i njena dostupna dokumentacija. Označite mjesta na kojima je dokument u suprotnosti ili izostavlja STVARNO ponašanje koda. Konačna odluka; Pošaljite ga na "verifikaciju programera".

Tri mini kofera (u brojevima)

Slučaj 1 — NatSpec je pojačao inspekciju. Jedan tim je dostavio ugovor sa 25 funkcija na razmatranje bez komentara; Revizor je tražio dodatno vrijeme da shvati logiku. Tim je napravio NatSpec nacrte sa AI i svaki potvrdio kodom; Priprema revizije je skraćena za skoro 1 dan. Pouka: dobra dokumentacija smanjuje troškove revizije.

Slučaj 2 — Lažna tvrdnja uhvaćena. U korisničkom priručniku koji je izradio YZ stoji da „vaša sredstva mogu biti povučena u bilo koje vrijeme“; dok je ugovor bio zaključan na 7 dana. Tehnički pregled je ovo otkrio. Da je objavljen, korisnici bi bili u zabludi i bili bi žrtvovani. Pouka: svaka tehnička tvrdnja je potvrđena kodom.

Slučaj 3 — Preterivanje je razjašnjeno. U prvom nacrtu bele knjige, AI je koristio izraze kao što su „visok prinos bez rizika“. Tim ih je uklonio i dodao dio o poštenom riziku. Time je zaštićen projekat i etički i pravno. Lekcija: marketinška pristrasnost AI mora biti revidirana.

Etičko opterećenje dokumentacije

Web3 dokumentacija se čita u kontekstu u kojem korisnik rizikuje svoj novac. dakle:

  • Iskrenost: Rizici se ne mogu sakriti i ne mogu se dati pretjerana obećanja.
  • Preciznost: Tehničke tvrdnje moraju odgovarati kodu; "Dokument tako kaže" nije odbrana, već lažno predstavljanje.
  • Pristupačnost: Pisanje na jeziku koji korisnik zaista razumije je sigurnosna mjera; Dokument koji se ne razume je poziv na obmanu.
  • Disclaimer: Treba jasno reći da to nije finansijski savjet i regulatorna nesigurnost.
Savjet: Test iskrenosti Web3 dokumenta: "Ako korisnik uloži novac u povjerenje samo ovom dokumentu, hoće li se osjećati prevarenim kada se suoči s istinom?" Neka AI uvijek istakne rizični dio, a ne da ga zakopa na kraju.

Uobičajene greške

  • Ne potvrđuje tehničku tvrdnju kodom. Pogrešan dokument dovodi korisnika u zabludu.
  • Napuštanje hype/marketinškog jezika. Etički i pravni rizik.
  • Minimiziranje ili skrivanje rizika. Kršenje povjerenja.
  • Štampanje bijelog papira bez davanja pravog mehanizma AI. Proizvodi izmišljotine.
  • Ignoriranje upozorenja "nije finansijski savjet". Pravna obaveza.
  • Ne usklađivanje dokumentacije sa kodom. Kada se šifra promijeni, dokument postaje pogrešan.

Ukratko

  • Dokumentacija je pitanje sigurnosti i povjerenja u Web3; To je najproduktivnije polje AI.
  • Cena greške je relativno niska, ali lažne tehničke tvrdnje i preterivanje predstavljaju ozbiljan rizik.
  • Svaka tehnička tvrdnja mora biti potvrđena pravim kodom; Dokument ne zamjenjuje šifru.
  • Rizici trebaju biti napisani iskreno i istaknuto; Preterivanje i jezik garancije treba ukloniti.
  • “To nije finansijski savjet” i regulatorna upozorenja su obavezna.

Zadatak aplikacije

Nabavite funkciju pametnog ugovora. Dajte AI prompt „Generate NatSpec“ i uporedite generisanu interpretaciju red po red sa stvarnim ponašanjem koda – ima li neslaganja? Zatim napravite "tehnički običan prijevod" i "odjeljak rizika/upozorenja" za istu funkciju. Pronađite i ispravite barem jednu izjavu AI koja je pretjerana ili je u suprotnosti s kodom.

kontrolna lista

  • [ ] Svaku tehničku tvrdnju sam potvrdio stvarnim kodom.
  • [ ] Uklonio sam pretjerivanja/garancije.
  • [ ] Napisao sam rizike iskreno i ističući ih.
  • [ ] Dao sam AI pravi mehanizam; Nisam mu dozvolila da to izmisli.
  • [ ] Dodao sam upozorenje "Ovo nije finansijski savjet."
  • [ ] Napisao sam NatSpec u cijelosti za vozilo i kontrolu.
  • [ ] Planirao sam da uskladim dokumentaciju sa kodom.