Unità 8 / 11

Dokumentazzjoni u Kitba Teknika: Whitepaper, NatSpec u Gwida għall-Utent

Qligħ:

  • Li tkun kapaċi tuża l-intelliġenza artifiċjali b'mod sikur fil-produzzjoni ta 'whitepaper, NatSpec, traduzzjoni teknika-sempliċi u żvelar tar-riskju u fehim li dan huwa l-aktar qasam produttiv.
  • Kapaċità li tivverifika kull talba teknika b'kodiċi attwali u tneħħi l-esaġerazzjoni u l-lingwa tal-garanzija biex tevita r-riskju ta 'dokumentazzjoni mhux korretta
  • Kapaċità li tħaddan ir-riskji b'mod onest, twissija 'mhux pariri finanzjarji' u konsistenza fil-kodiċi tad-dokumentazzjoni

Dokumentazzjoni fil-Web3 mhix lussu, iżda kwistjoni ta 'sigurtà u fiduċja. Billi jinteraġixxi ma 'kuntratt intelliġenti, l-utent jirriskja l-flus reali tiegħu; Jekk ma jifhimx x’qed jagħmel, huwa miftuħ li jiġi mqarraq. L-awditur ma jistax jirrevedi b'mod sikur kodiċi li mhux dokumentat tajjeb. F'din l-unità, aħna nkopru l-qasam fejn l-AI hija l-aktar affidabbli u effiċjenti: dokumentazzjoni u kitba teknika. Minn whitepaper għal kummenti fil-kodiċi, minn gwida għall-utent għal żvelar tar-riskju, l-AI hija multiplikatur tal-forza reali hawnhekk - sakemm l-eżattezza tkun immonitorjata b'mod uman.

Tipi ta' dokumentazzjoni tal-Web3

  • Whitepaper / litepaper: Id-dokument bażiku li jiddeskrivi l-viżjoni, il-mekkaniżmu u t-tokenomics tal-proġett.
  • Dokumentazzjoni teknika: Interfaces tal-kuntratt, gwida għall-integrazzjoni għall-iżviluppaturi.
  • NatSpec (Speċifikazzjoni tal-Lingwa Naturali Ethereum — Format standard ta' kumment fil-kodiċi f'Solidità li jiddeskrivi x'inhuma l-funzjonijiet): Dokumentazzjoni inkorporata fil-kodiċi, moqrija kemm mill-bniedem kif ukoll mill-għodda.
  • Gwida għall-utent: Test sempliċi li jgħid lill-utent aħħari "kif juża, x'riskji hemm".
  • Ċaħda ta' responsabbiltà: Twissijiet meħtieġa legalment u etikament.

Problema komuni b'dawn it-tipi: l-iżviluppaturi ma jħobbux jiktbu u ħafna drabi jħalluha għall-aħħar mument. L-AI timla eżattament dan il-vojt.

Għaliex id-dokumentazzjoni hija l-aktar qasam sikur tal-AI

L-ispiża ta 'żball fid-dokumentazzjoni hija aktar baxxa milli fl-awditjar: sentenza waħda mhux korretta hija kkoreġuta, l-ebda flus itir (direttament). Barra minn hekk, l-AI hija b'saħħitha b'mod naturali fil-produzzjoni tal-lingwa. Allura l-AI hija kemm effiċjenti kif ukoll relattivament sikura hawn. Iżda għad fadal żewġ riskji kritiċi:

  1. Talba teknika falza: AI tista' tirrappreżenta ħażin dak li jagħmel il-kodiċi; Dan iqarraq bl-utent u jista 'jsir vulnerabbiltà tas-sigurtà (sakemm ma tgħid "din il-funzjoni tipproteġi l-fondi tiegħek" u ma tagħmilx).
  2. Lingwa tal-iperbole/kummerċjalizzazzjoni: AI tista' tipproduċi lingwaġġ li jagħmel proġett jidher sikur jew profittabbli; Din hija problema kemm etika kif ukoll legali.
Attenzjoni: Id-dokumentazzjoni tiddeskrivi l-kodiċi; Mhuwiex il-kodiċi innifsu. Kull affermazzjoni teknika li tikteb l-AI ("dan ​​jiġri", "li żżomm") trid tiġi vverifikata mal-kodiċi attwali. Dokumentazzjoni mhux korretta tista 'tkun aktar perikoluża minn kodiċi korrett minħabba li l-utent jafda d-dokumentazzjoni.

Saffi tal-użu tal-AI fid-dokumentazzjoni

1. Ġenerazzjoni NatSpec. L-AI taqra funzjoni eżistenti u tabbozza l-interpretazzjoni NatSpec: x'tagħmel, x'inhuma l-parametri tagħha, x'jirritorna. Dan jissimplifika l-ispezzjoni u l-manutenzjoni.

2. Traduzzjoni teknika-sempliċi. L-AI tittraduċi mekkaniżmu kumpless f'lingwa li l-utent aħħari jista' jifhem - waħda mill-akbar ħtiġijiet tal-Web3.

3. Kontorn u struttura tal-Whitepaper. AI tipproduċi l-iskeletru u sezzjonijiet ta 'whitepaper; L-eżattezza tal-kontenut hija umana.

4. Multilingwiżmu u aġġustament fil-livell. L-AI tista' tipproduċi l-istess kontenut, kemm tekniku kif ukoll sempliċi, kemm bit-Tork kif ukoll bl-Ingliż.

Pront dgħajjef / Pront qawwi

Pront dgħajjef:

Ikteb whitepaper għal dan il-proġett.

L-AI tagħmel kopja esaġerata, possibilment falza, u mimlija bil-marketing mingħajr ma tkun taf il-mekkaniżmu attwali.

Pront qawwi:

Ir-rwol tiegħek: kittieb tekniku tal-Web3. Hawn taħt hemm il-mekkaniżmu REAL, it-tokenomics u l-kodiċi tal-proġett. Ikteb abbozz ta' whitepaper ibbażat biss fuq din l-informazzjoni. Regoli:- Tesaġerax, TUŻAX frażijiet bħal "profitt garantit", "kompletament sigur" eċċ.- Ibbaża kull talba teknika fuq il-mekkaniżmu li nagħti; Żidx fabbrikazzjoni.- Żid taqsima "Riskji" li tiddikjara b'mod ċar ir-riskji.- Żid twissija "Dan mhux parir finanzjarju." Immarka kwalunkwe informazzjoni li m'intix ċert biha jew li m'għandix bħala [BIEX JIĠI MLI].

Erba' mudelli li jistgħu jiġu kkupjati

1) Ġenerazzjoni NatSpec:

Ikteb kummenti standard NatSpec għall-funzjoni li ġejja: @notice (x'jagħmel, sempliċi), @dev (nota teknika), @param u @return. Ikteb biss dak li fil-fatt jagħmel il-kodiċi; Żieda ta 'imġieba li mhix fil-kodiċi. Bandiera l-effett li m'intix ċert dwaru.

2) Traduzzjoni teknika-sempliċi:

Spjega dan il-mekkaniżmu bit-Tork sempliċi li utent kripto novizzi jista 'jifhem: x'jagħmel, x'għandu jagħmel l-utent, X'RISKJI hemm? Esaġerazzjoni; ebda garanzija ta’ sigurtà. Taħbix ir-riskji, ġibhom fuq quddiem.

3) Taqsima tar-riskju/twissija:

Ikteb taqsima onesta "Riskji u twissijiet" għal dan il-proġett: riskju smartcontract, riskju tas-suq, riskju ta 'likwidità, inċertezza regolatorja, telf ewlieni. Spjega kull riskju b'lingwaġġ sempliċi. Tissottovalutax ir-riskji; tispiċċa b'"dan mhux parir finanzjarju."

4) Kontroll tal-konsistenza tal-kodiċi tad-dokumentazzjoni:

Hawn taħt hemm funzjoni u d-dokumentazzjoni disponibbli tagħha. Immarka l-postijiet fejn id-dokument jikkontradixxi jew iħalli barra l-imġieba ATTWALI tal-kodiċi. Teħid ta' deċiżjonijiet finali; Ibgħatha għal "verifika tal-iżviluppatur".

Tliet kaxxi żgħar (f'numri)

Każ 1 — NatSpec żiedet l-ispezzjoni. Tim wieħed issottometta kuntratt ta' 25 funzjoni għal reviżjoni mingħajr kumment; L-awditur talab ħin żejjed biex jifhem il-loġika. It-tim ipproduċa abbozzi NatSpec bl-AI u kkonferma kull wieħed bil-kodiċi; Il-preparazzjoni tal-awditjar tqassar bi kważi ġurnata. Lezzjoni: dokumentazzjoni tajba tnaqqas l-ispiża tal-verifika.

Każ 2 — Talba falza maqbuda. Il-manwal tal-utent li pproduċiet YZ iddikjara li "l-fondi tiegħek jistgħu jiġu rtirati fi kwalunkwe ħin"; billi kien hemm lock ta' 7 ijiem fil-kuntratt. Ir-reviżjoni teknika qabdet dan. Kieku tiġi ppubblikata, l-utenti jkunu żbaljati u ivvittimizzati. Lezzjoni: kull talba teknika hija kkonfermata bil-kodiċi.

Każ 3 — Eżaġerazzjoni ċċarata. Fl-ewwel abbozz tal-whitepaper, AI użat espressjonijiet bħal "redditu għoli mingħajr riskju". It-tim neħħa dawn u żied taqsima tar-riskju onesta. Dan ipproteġiet il-proġett kemm etikament kif ukoll legalment. Lezzjoni: Il-preġudizzju tal-kummerċjalizzazzjoni tal-AI għandu jiġi vverifikat.

Piż etiku tad-dokumentazzjoni

Id-dokumentazzjoni tal-Web3 tinqara f'kuntest fejn l-utent qed jirriskja l-flus tiegħu. Għalhekk:

  • Onestà: Ir-riskji ma jistgħux jinħbew u ma jistgħux isiru wegħdiet esaġerati.
  • Eżattezza: Pretensjonijiet tekniċi għandhom jaqblu mal-kodiċi; "Id-dokument jgħid hekk" mhix difiża, iżda pjuttost rappreżentazzjoni ħażina.
  • Aċċessibilità: Il-kitba b'lingwa li l-utent fil-fatt jifhem hija miżura ta' sigurtà; Dokument li mhux mifhum huwa stedina għall-qerq.
  • Ċaħda ta' responsabbiltà: Għandu jiġi ddikjarat b'mod ċar li mhuwiex parir finanzjarju u inċertezza regolatorja.
Tip: Test tal-onestà ta' dokument Web3: "Jekk utent ipoġġi l-flus biex jafda biss f'dan id-dokument, se jħossu mqarraq meta jiffaċċja l-verità?" Dejjem għandek l-AI tenfasizza l-parti tar-riskju, mhux midfunha fl-aħħar.

Żbalji komuni

  • Mhux tikkonferma t-talba teknika bil-kodiċi. Id-dokument ħażin iqarraq bl-utent.
  • Waqqa 'l-hype/lingwa tal-kummerċjalizzazzjoni. Riskju etiku u legali.
  • Minimizzazzjoni jew ħabi tar-riskji. Ksur ta' fiduċja.
  • Stampar tal-whitepaper mingħajr ma jagħti l-mekkaniżmu reali lill-AI. Tipproduċi fabbrikazzjonijiet.
  • Tinjora t-twissija "mhux parir finanzjarju". Obbligu legali.
  • Mhux iżżomm id-dokumentazzjoni sinkronizzata mal-kodiċi. Meta l-kodiċi jinbidel, id-dokument isir qarrieqi.

Fil-qosor

  • Id-dokumentazzjoni hija kwistjoni ta' sigurtà u fiduċja fil-Web3; Huwa l-aktar qasam produttiv tal-AI.
  • L-ispiża tal-iżball hija relattivament baxxa, iżda talbiet tekniċi foloz u eżaġerazzjoni huma riskji serji.
  • Kull talba teknika għandha tkun ikkonfermata b'kodiċi reali; Id-dokument ma jissostitwixxix il-kodiċi.
  • Ir-riskji għandhom jinkitbu b'mod onest u prominenti; L-esaġerazzjoni u l-lingwaġġ ta' garanzija għandhom jitneħħew.
  • "Mhux parir finanzjarju" u twissijiet regolatorji huma obbligatorji.

Kompitu ta' applikazzjoni

Ikseb funzjoni ta 'kuntratt intelliġenti. Agħti lill-AI il-pront "Iġġenera NatSpec" u qabbel l-interpretazzjoni ġġenerata linja b'linja ma 'l-imġieba attwali tal-kodiċi - hemm xi nuqqas ta' qbil? Imbagħad ipproduċi "traduzzjoni teknika-sempliċi" u "sezzjoni ta' riskju/twissija" għall-istess funzjoni. Sib u kkoreġi mill-inqas dikjarazzjoni waħda tal-AI li hija esaġerata jew tikkontradixxi l-kodiċi.

lista ta' kontroll

  • [ ] I kkonfermat kull talba teknika bil-kodiċi attwali.
  • [ ] Neħħejt l-esaġerazzjonijiet/garanziji.
  • [ ] Jien ktibt ir-riskji b'mod onest u enfasizzathom.
  • [ ] Jien tajt lill-AI il-mekkaniżmu reali; I ma ħalliehx jagħmel it up.
  • [ ] Żidt it-twissija "Dan mhux parir finanzjarju."
  • [ ] Jien ktibt NatSpec kollu għall-vettura u l-kontroll.
  • [ ] Ippjanajt li nżomm id-dokumentazzjoni sinkronizzata mal-kodiċi.