Vienība 8 / 11

Dokumentācija un tehniskā rakstīšana: Whitepaper, NatSpec un lietotāja rokasgrāmata

Ieguvumi:

  • Spēja droši izmantot mākslīgo intelektu, izstrādājot informatīvo dokumentu, NatSpec, tehniski vienkāršu tulkojumu un risku izpaušanu, un saprast, ka šī ir visproduktīvākā joma.
  • Iespēja pārbaudīt katru tehnisko pretenziju ar faktisko kodu un noņemt pārspīlējumu un garantijas valodu, lai izvairītos no nepareizas dokumentācijas riska
  • Spēja godīgi uzņemties riskus, brīdinājums “nevis finanšu konsultācijas” un dokumentācijas koda konsekvence

Dokumentācija Web3 nav greznība, bet gan drošības un uzticamības jautājums. Mijiedarbojoties ar viedo līgumu, lietotājs riskē ar savu reālo naudu; Ja viņš nesaprot, ko dara, viņš ir atvērts maldināšanai. Revidents nevar droši pārskatīt kodu, kas nav labi dokumentēts. Šajā nodaļā mēs aptveram jomu, kurā AI ir visuzticamākā un efektīvākā: dokumentācija un tehniskā rakstīšana. No dokumentiem līdz komentāriem kodā, no lietotāja rokasgrāmatas līdz riska izpaušanai, mākslīgais intelekts šeit ir īsts spēka pavairotājs — ja vien tiek humāni uzraudzīta precizitāte.

Web3 dokumentācijas veidi

  • Whitepaper / Litepaper: pamatdokuments, kas apraksta projekta vīziju, mehānismu un tokenomiku.
  • Tehniskā dokumentācija: Līgumu saskarnes, integrācijas rokasgrāmata izstrādātājiem.
  • NatSpec (Ethereum dabiskās valodas specifikācija — standarta Solidity koda komentāru formāts, kas apraksta, ko veic funkcijas): kodā iegulta dokumentācija, ko lasa gan cilvēks, gan rīks.
  • Lietotāja rokasgrāmata: vienkāršs teksts, kurā gala lietotājam ir pateikts "kā lietot, kādi riski pastāv".
  • Atruna: juridiski un ētiski nepieciešami brīdinājumi.

Bieži sastopama problēma ar šiem veidiem: izstrādātājiem nepatīk rakstīt un bieži to atstāj uz pēdējo brīdi. AI aizpilda tieši šo plaisu.

Kāpēc dokumentācija ir AI drošākā joma?

Kļūdas izmaksas dokumentācijā ir zemākas nekā auditā: tiek izlabots viens nepareizs teikums, nauda nelido (tieši). Turklāt mākslīgais intelekts, protams, ir spēcīgs valodu veidošanā. Tātad mākslīgais intelekts šeit ir gan efektīvs, gan salīdzinoši drošs. Bet joprojām ir divi būtiski riski:

  1. Nepatiess tehnisks apgalvojums: AI var sagrozīt koda darbību; Tas maldina lietotāju un var kļūt par drošības ievainojamību (ja vien nav rakstīts "šī funkcija aizsargā jūsu līdzekļus" un nē).
  2. Hiperbola/mārketinga valoda: AI var radīt valodu, kas padara projektu drošu vai rentablu; Tā ir gan ētiska, gan juridiska problēma.
Uzmanību: dokumentācijā ir aprakstīts kods; Tas nav pats kods. Katrs tehniskais apgalvojums, ko raksta AI ("tas notiek", "kas saglabā"), ir jāpārbauda attiecībā pret faktisko kodu. Nepareiza dokumentācija var būt bīstamāka par pareizu kodu, jo lietotājs dokumentācijai uzticas.

AI izmantošanas slāņi dokumentācijā

1. NatSpec paaudze. AI nolasa esošu funkciju un izstrādā NatSpec interpretāciju: ko tas dara, kādi ir tā parametri, ko tas atgriež. Tas vienkāršo pārbaudi un apkopi.

2. Tehniski vienkāršs tulkojums. AI pārvērš sarežģītu mehānismu galalietotājam saprotamā valodā — viena no lielākajām Web3 vajadzībām.

3. Baltā papīra kontūra un struktūra. AI izveido baltās papīra skeletu un sadaļas; Satura precizitāte ir cilvēciska.

4. Daudzvalodība un līmeņa pielāgošana. AI var radīt vienu un to pašu saturu, gan tehnisko, gan vienkāršu gan turku, gan angļu valodā.

Vāja uzvedne / spēcīga uzvedne

Vāja uzvedne:

Uzrakstiet šī projekta balto grāmatu.

AI veido pārspīlētu, iespējams, nepatiesu un mārketinga pilnu kopiju, nezinot patieso mehānismu.

Spēcīga uzvedne:

Jūsu loma: Web3 tehniskais rakstnieks. Zemāk ir projekta REĀLAIS mehānisms, tokenomika un kods. Uzrakstiet baltās grāmatas projektu, pamatojoties tikai uz šo informāciju. Noteikumi: - Nepārspīlējiet, NELIETOJIET tādas frāzes kā "garantēta peļņa", "pilnīgi drošs" utt.- Katru tehnisko prasību pamatojiet ar manis sniegto mehānismu; Nepievienojiet izdomājumus.- Pievienojiet sadaļu "Riski", kurā skaidri norādīti riski.- Pievienojiet brīdinājumu "Tas nav finanšu padoms." Jebkuru informāciju, par kuru neesat pārliecināts vai kuras man nav, atzīmējiet kā [JĀAIZPILDĪT].

Četras kopējamas veidnes

1) NatSpec paaudze:

Rakstiet standarta NatSpec komentārus šādai funkcijai: @notice (kas darbojas, vienkāršs), @dev (tehniska piezīme), @param un @return. Rakstiet tikai to, ko kods PATIESĪBĀ dara; Uzvedības pievienošana, kas nav kodā. Atzīmējiet efektu, par kuru neesat pārliecināts.

2) Tehniski vienkāršs tulkojums:

Izskaidrojiet šo mehānismu vienkāršā turku valodā, ko var saprast kriptogrāfijas iesācējs lietotājs: ko tas dara, kas lietotājam jādara, KĀDI RISKI pastāv? Pārspīlējums; nekādas drošības garantijas. Neslēpiet riskus, izvirziet tos priekšplānā.

3) Riska/brīdinājuma sadaļa:

Uzrakstiet godīgu sadaļu "Riski un brīdinājumi" šim projektam: viedlīguma risks, tirgus risks, likviditātes risks, regulējuma nenoteiktība, atslēgas zaudējumi. Izskaidrojiet katru risku vienkāršā valodā. Nenovērtējiet par zemu riskus; beidzas ar "tas nav finanšu padoms."

4) Dokumentācijas koda atbilstības pārbaude:

Tālāk ir norādīta funkcija un tās pieejamā dokumentācija. Atzīmējiet vietas, kur dokuments ir pretrunā vai izlaiž koda FAKTIŠO uzvedību. Galīgo lēmumu pieņemšana; Iesniedziet to "izstrādātāja verifikācijai".

Trīs mini futrāļi (skaitļos)

1. gadījums — NatSpec pastiprināta pārbaude. Viena komanda iesniedza pārskatīšanai līgumu uz 25 funkcijām bez komentāriem; Revidents lūdza papildu laiku, lai saprastu loģiku. Komanda izstrādāja NatSpec melnrakstus ar AI un apstiprināja katru ar kodu; Revīzijas sagatavošana tika saīsināta gandrīz par 1 dienu. Nodarbība: laba dokumentācija samazina revīzijas izmaksas.

2. gadījums — konstatēta nepatiesa prasība. YZ izstrādātajā lietotāja rokasgrāmatā bija teikts, ka “jūsu līdzekļus var izņemt jebkurā laikā”; tā kā līgumā bija 7 dienu bloķēšana. Tehniskā apskate to uztvēra. Ja tas tiktu publicēts, lietotāji kļūdītos un kļūtu par upuriem. Nodarbība: katru tehnisko pretenziju apstiprina kods.

3. gadījums — pārspīlējums ir novērsts. Pirmajā dokumenta projektā AI izmantoja tādus izteicienus kā "augsta atdeve bez riska". Komanda tos noņēma un pievienoja godīgu riska sadaļu. Tas aizsargāja projektu gan ētiski, gan juridiski. Nodarbība: AI mārketinga aizspriedumi ir jāpārbauda.

Dokumentācijas ētiskais slogs

Web3 dokumentācija tiek lasīta kontekstā, kurā lietotājs riskē ar savu naudu. Tāpēc:

  • Godīgums: riskus nevar slēpt un nevar dot pārspīlētus solījumus.
  • Precizitāte: Tehniskajām pretenzijām jāatbilst kodam; "Dokumentā tā teikts" nav aizstāvība, bet gan maldinoša informācija.
  • Pieejamība: rakstīšana valodā, kuru lietotājs faktiski saprot, ir drošības pasākums; Dokuments, kas nav saprotams, ir aicinājums uz maldināšanu.
  • Atruna: skaidri jānorāda, ka tas nav finansiāls padoms un regulējuma nenoteiktība.
Padoms: Web3 dokumenta godīguma pārbaude: "Ja lietotājs iegulda naudu, uzticoties tikai šim dokumentam, vai viņš jutīsies maldināts, saskaroties ar patiesību?" Vienmēr lieciet AI izcelt riska daļu, nevis apglabāt to beigās.

Biežas kļūdas

  • Neapstiprina tehnisko pretenziju ar kodu. Nepareizs dokuments maldina lietotāju.
  • Atteikšanās no ažiotāžas/mārketinga valodas. Ētiskais un juridiskais risks.
  • Risku samazināšana vai slēpšana. Uzticības pārkāpšana.
  • Papīra drukāšana, nedodot AI īsto mehānismu. Tas ražo izdomājumus.
  • Brīdinājuma “nevis finanšu padoms” ignorēšana. Juridiskais pienākums.
  • Dokumentācija netiek sinhronizēta ar kodu. Kad kods mainās, dokuments kļūst maldinošs.

Rezumējot

  • Dokumentācija ir Web3 drošības un uzticamības jautājums; Tā ir visproduktīvākā AI joma.
  • Kļūdas izmaksas ir salīdzinoši zemas, taču nepatiesi tehniski apgalvojumi un pārspīlēšana ir nopietni riski.
  • Katra tehniskā pretenzija jāapstiprina ar reālu kodu; Dokuments neaizstāj kodu.
  • Riski jāraksta godīgi un skaidri redzami; Pārspīlējumi un garantijas valoda ir jānovērš.
  • “Tā nav finanšu konsultācija” un normatīvie brīdinājumi ir obligāti.

Lietojumprogrammas uzdevums

Iegūstiet viedo līguma funkciju. Dodiet AI uzvedni “Ģenerēt NatSpec” un salīdziniet ģenerēto interpretāciju pēc rindas ar koda faktisko uzvedību — vai ir kādas domstarpības? Pēc tam izveidojiet "tehniski vienkāršu tulkojumu" un "riska/brīdinājuma sadaļu" vienai un tai pašai funkcijai. Atrodiet un izlabojiet vismaz vienu AI apgalvojumu, kas ir pārspīlēts vai ir pretrunā ar kodu.

kontrolsaraksts

  • [ ] Es apstiprināju katru tehnisko pretenziju ar faktisko kodu.
  • [ ] Es noņēmu pārspīlējumus/garantijas.
  • [ ] Riskus uzrakstīju godīgi un tos izceļot.
  • [ ] Es iedevu AI īsto mehānismu; Es neļāvu viņam izdomāt.
  • [ ] Es pievienoju brīdinājumu "Tas nav finanšu padoms."
  • [ ] Es pilnībā uzrakstīju NatSpec transportlīdzeklim un kontrolei.
  • [ ] Es plānoju dokumentāciju sinhronizēt ar kodu.