Jedinica 8 / 11

Dokumentacija i tehničko pisanje: Whitepaper, NatSpec i korisnički priručnik

Dobici:

  • Biti u mogućnosti sigurno koristiti umjetnu inteligenciju u izradi whitepapera, NatSpec, tehnički jednostavnog prijevoda i otkrivanja rizika te razumijevanje da je to najproduktivnije područje.
  • Sposobnost provjere svake tehničke tvrdnje stvarnim kodom i uklanjanje pretjerivanja i jezika jamstva kako bi se izbjegao rizik od netočne dokumentacije
  • Sposobnost iskrenog prihvaćanja rizika, upozorenje 'ne financijski savjet' i dosljednost koda dokumentacije

Dokumentacija u Web3 nije luksuz, već stvar sigurnosti i povjerenja. Interakcijom s pametnim ugovorom korisnik riskira svoj stvarni novac; Ako ne razumije što radi, spreman je biti prevaren. Revizor ne može sigurno pregledati kod koji nije dobro dokumentiran. U ovoj jedinici pokrivamo područje u kojem je umjetna inteligencija najpouzdanija i najučinkovitija: dokumentacija i tehničko pisanje. Od bijele knjige do komentara u kodu, od korisničkog vodiča do otkrivanja rizika, umjetna inteligencija ovdje je pravi multiplikator snage — sve dok se točnost nadzire ljudski.

Vrste Web3 dokumentacije

  • Whitepaper / litepaper: Osnovni dokument koji opisuje viziju, mehanizam i tokenomiku projekta.
  • Tehnička dokumentacija: Ugovorna sučelja, vodič za integraciju za programere.
  • NatSpec (Specifikacija prirodnog jezika Ethereum — standardni format komentara u kodu u Solidityju koji opisuje što funkcije rade): Dokumentacija ugrađena u kod, koju čitaju i ljudi i alati.
  • Korisnički priručnik: običan tekst koji govori krajnjem korisniku "kako koristiti, koji rizici postoje".
  • Odricanje od odgovornosti: zakonski i etički potrebna upozorenja.

Čest problem s ovim vrstama: programeri ne vole pisati i često to ostavljaju za posljednji trenutak. AI ispunjava upravo ovu prazninu.

Zašto je dokumentacija najsigurnije područje umjetne inteligencije

Cijena pogreške u dokumentaciji niža je nego u reviziji: ispravi se jedna netočna rečenica, novac ne leti (izravno). Osim toga, umjetna inteligencija je prirodno jaka u stvaranju jezika. Dakle, umjetna inteligencija je ovdje i učinkovita i relativno sigurna. Ali dva kritična rizika ostaju:

  1. Lažna tehnička tvrdnja: AI može krivo predstaviti što kod radi; To dovodi korisnika u zabludu i može postati sigurnosna ranjivost (osim ako piše "ova funkcija štiti vaša sredstva", a ne piše).
  2. Hiperbola/marketinški jezik: AI može proizvesti jezik koji čini projekt sigurnim ili isplativim; Ovo je i etički i pravni problem.
Oprez: dokumentacija opisuje kod; To nije sam kod. Svaka tehnička tvrdnja koju AI napiše ("ovo se događa", "ono održava") mora se provjeriti u odnosu na stvarni kod. Netočna 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 nacrta NatSpec interpretaciju: što radi, koji su joj parametri, što vraća. Ovo pojednostavljuje pregled i održavanje.

2. Tehnički-jednostavni prijevod. AI prevodi složeni mehanizam u jezik koji krajnji korisnik može razumjeti — jedna od najvećih potreba Web3.

3. Nacrt i struktura bijele knjige. AI proizvodi kostur i dijelove bijelog papira; Točnost sadržaja je ljudska.

4. Višejezičnost i prilagodba razine. AI može proizvesti isti sadržaj, tehnički i običan, i na turskom i na engleskom.

Slab upit / Jak upit

Slab upit:

Napišite bijeli papir za ovaj projekt.

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

Snažan upit:

Vaša uloga: Web3 tehnički pisac. Ispod je REAL mehanizam, tokenomika i kod projekta. Napišite nacrt bijele knjige isključivo na temelju ovih informacija. Pravila:- Nemojte pretjerivati, NEMOJTE koristiti izraze poput "zajamčena dobit", "potpuno siguran" itd.- Temeljite svaku tehničku tvrdnju na mehanizmu koji dajem; Nemojte dodavati izmišljotine.- Dodajte odjeljak "Rizici" koji jasno navodi rizike.- Dodajte upozorenje "Ovo nije financijski savjet." Označite sve podatke za koje niste sigurni ili koje ja nemam kao [TO BE FILLED].

Četiri predloška za kopiranje

1) NatSpec generacija:

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

2) tehnički-jednostavni prijevod:

Objasnite ovaj mehanizam na jednostavnom turskom jeziku koji korisnik kripto početnik može razumjeti: što radi, što bi korisnik trebao učiniti, KOJI RIZICI postoje? Pretjerivanje; nema jamstva sigurnosti. Ne skrivajte rizike, iznesite ih u prvi plan.

3) Dio rizika/upozorenja:

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

4) Provjera dosljednosti koda i dokumentacije:

Ispod je funkcija i dostupna dokumentacija. Označite mjesta na kojima dokument proturječi ili izostavlja STVARNO ponašanje koda. Donošenje konačne odluke; Pošaljite ga na "provjeru programera".

Tri mini kofera (u broju)

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

Slučaj 2 — Uhvaćena lažna tvrdnja. U korisničkom priručniku koji je napravio YZ navedeno je da se "vaša sredstva mogu povući u bilo kojem trenutku"; dok je u ugovoru postojalo zaključavanje od 7 dana. Tehnički pregled je to uhvatio. Kad bi se to objavilo, korisnici bi bili u zabludi i žrtve. Lekcija: svaka tehnička tvrdnja potvrđena je kodom.

Slučaj 3 — Pretjerivanje razjašnjeno. U prvom nacrtu whitepapera AI je koristio izraze kao što je "visoki povrat bez rizika". Tim ih je uklonio i dodao odjeljak o poštenom riziku. Time je projekt zaštićen i etički i pravno. Lekcija: Marketinška pristranost umjetne inteligencije mora se provjeriti.

Etički teret dokumentacije

Web3 dokumentacija čita se u kontekstu u kojem korisnik riskira svoj novac. Stoga:

  • Iskrenost: Rizici se ne mogu sakriti i ne mogu se dati pretjerana obećanja.
  • Točnost: tehničke tvrdnje moraju odgovarati kodu; "Dokument tako kaže" nije obrana, već krivo predstavljanje.
  • Pristupačnost: Pisanje na jeziku koji korisnik zapravo razumije je sigurnosna mjera; Dokument koji se ne razumije je poziv na prijevaru.
  • Odricanje od odgovornosti: Treba jasno navesti da to nije financijski savjet i regulatorna nesigurnost.
Savjet: Test poštenja Web3 dokumenta: "Ako korisnik uloži novac vjerujući 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 zatrpa na kraju.

Uobičajene greške

  • Tehnička tvrdnja nije potvrđena kodom. Pogrešan dokument dovodi korisnika u zabludu.
  • Odbacivanje hype/marketinškog jezika. Etički i pravni rizik.
  • Minimiziranje ili skrivanje rizika. Povreda povjerenja.
  • Ispisivanje bijelog papira bez davanja pravog mehanizma AI-ju. Proizvodi izmišljotine.
  • Ignoriranje upozorenja "nije financijski savjet". Zakonska obveza.
  • Dokumentacija nije usklađena s kodom. Kada se kod promijeni, dokument postaje pogrešan.

Ukratko

  • Dokumentacija je stvar sigurnosti i povjerenja u Web3; To je najproduktivnije polje umjetne inteligencije.
  • Trošak pogreške je relativno nizak, ali lažne tehničke tvrdnje i pretjerivanje predstavljaju ozbiljne rizike.
  • Svaka tehnička tvrdnja mora biti potvrđena pravim kodom; Dokument ne zamjenjuje šifru.
  • Rizici trebaju biti napisani pošteno i vidljivo; Treba ukloniti jezik pretjerivanja i jamstva.
  • "To nije financijski savjet" i regulatorna upozorenja su obvezna.

Zadatak aplikacije

Nabavite funkciju pametnog ugovora. Dajte AI-u upit "Generate NatSpec" i usporedite generirano tumačenje redak po redak sa stvarnim ponašanjem koda - postoje li neslaganja? Zatim napravite "jednostavni tehnički prijevod" i "odjeljak o riziku/upozorenju" za istu funkciju. Pronađite i ispravite barem jednu izjavu AI koja je pretjerana ili proturječna kodu.

popis za provjeru

  • [ ] Potvrdio sam svaku tehničku tvrdnju stvarnim kodom.
  • [ ] Uklonio sam pretjerivanja/jamstva.
  • [ ] Iskreno sam napisao rizike i istaknuo ih.
  • [ ] Dao sam AI pravi mehanizam; Nisam mu dopustio da to izmisli.
  • [ ] Dodao sam upozorenje "Ovo nije financijski savjet."
  • [ ] Napisao sam NatSpec u cijelosti za vozilo i kontrolu.
  • [ ] Planirao sam održavati dokumentaciju sinkroniziranom s kodom.