Winst:
- Het veilig kunnen gebruiken van kunstmatige intelligentie bij het produceren van whitepapers, NatSpec, technisch-eenvoudige vertalingen en openbaarmaking van risico's, en begrijpen dat dit het meest productieve vakgebied is.
- Mogelijkheid om elke technische claim te verifiëren met daadwerkelijke code en overdrijvingen en garantietaal te verwijderen om het risico van onjuiste documentatie te voorkomen
- Vermogen om risico's eerlijk te omarmen, 'geen financieel advies'-waarschuwing en consistentie van documentatiecodes
Documentatie in Web3 is geen luxe, maar een kwestie van veiligheid en vertrouwen. Door interactie met een slim contract riskeert de gebruiker zijn echte geld; Als hij niet begrijpt wat hij doet, staat hij open voor misleiding. De auditor kan code die niet goed gedocumenteerd is, niet veilig beoordelen. In deze unit behandelen we het gebied waarop AI het meest betrouwbaar en efficiënt is: documentatie en technisch schrijven. Van whitepaper tot commentaar in de code, van gebruikershandleiding tot openbaarmaking van risico's: AI is hier een echte krachtvermenigvuldiger – zolang de nauwkeurigheid op humane wijze wordt gecontroleerd.
Soorten Web3-documentatie
- Whitepaper / litepaper: Het basisdocument dat de visie, het mechanisme en de tokenomics van het project beschrijft.
- Technische documentatie: Contractinterfaces, integratiegids voor ontwikkelaars.
- NatSpec (Ethereum Natural Language Specification - Standaard in-code commentaarformaat in Solidity dat beschrijft wat functies doen): Documentatie ingebed in code, gelezen door zowel mens als hulpmiddel.
- Gebruikershandleiding: Platte tekst die de eindgebruiker vertelt "hoe te gebruiken en welke risico's er zijn".
- Disclaimer: Juridisch en ethisch vereiste waarschuwingen.
Een veelvoorkomend probleem bij dit soort types: ontwikkelaars houden niet van schrijven en laten dit vaak tot het laatste moment over. AI vult precies dit gat.
Waarom documentatie het veiligste gebied van AI is
De kosten van fouten bij documentatie zijn lager dan bij audits: één foutieve zin wordt gecorrigeerd, er vliegt geen geld (direct) weg. Bovendien is AI van nature sterk in taalproductie. AI is hier dus zowel efficiënt als relatief veilig. Maar er blijven twee kritieke risico’s bestaan:
- Valse technische claim: AI kan een verkeerde voorstelling geven van wat de code doet; Dit misleidt de gebruiker en kan een beveiligingsprobleem worden (tenzij er staat "deze functie beschermt uw geld" en dat niet het geval is).
- Hyperbool/marketingtaal: AI kan taal produceren die een project veilig of winstgevend doet lijken; Dit is zowel een ethisch als een juridisch probleem.
Let op: de documentatie beschrijft de code; Het is niet de code zelf. Elke technische bewering die de AI schrijft (“dit gebeurt”, “die handhaaft”) moet worden geverifieerd aan de hand van daadwerkelijke code. Onjuiste documentatie kan gevaarlijker zijn dan correcte code, omdat de gebruiker de documentatie vertrouwt.
Lagen voor het gebruik van AI in documentatie
1. NatSpec-generatie. De AI leest een bestaande functie uit en stelt de NatSpec-interpretatie op: wat deze doet, wat de parameters zijn, wat deze retourneert. Dit vereenvoudigt inspectie en onderhoud.
2. Technisch-eenvoudige vertaling. AI vertaalt een complex mechanisme in taal die de eindgebruiker kan begrijpen – een van de grootste behoeften van Web3.
3. Overzicht en structuur van het whitepaper. AI produceert het skelet en de secties van een whitepaper; Nauwkeurigheid van inhoud is menselijk.
4. Meertaligheid en niveauaanpassing. AI kan dezelfde inhoud produceren, zowel technisch als eenvoudig, in zowel het Turks als het Engels.
Zwakke prompt/sterke prompt
Zwakke prompt:
Schrijf een whitepaper voor dit project.
De AI verzint overdreven, mogelijk valse, en met marketing gevulde kopieën zonder het eigenlijke mechanisme te kennen.
Krachtige prompt:
Jouw rol: Web3 technisch schrijver. Hieronder vindt u het ECHTE mechanisme, de tokenomics en de code van het project. Schrijf een concept van een whitepaper uitsluitend op basis van deze informatie. Regels: - Overdrijf niet, gebruik GEEN uitdrukkingen als "gegarandeerde winst", "volledig veilig" enz. - Baseer elke technische claim op het mechanisme dat ik geef; Voeg geen verzinsel toe. - Voeg een sectie 'Risico's' toe waarin de risico's duidelijk worden vermeld. - Voeg een waarschuwing toe: 'Dit is geen financieel advies.' Markeer alle informatie waarvan u niet zeker bent of die ik niet heb als [IN TE VULLEN].
Vier kopieerbare sjablonen
1) NatSpec-generatie:
Schrijf standaard NatSpec-opmerkingen naar de volgende functie: @notice (wat doet het, gewoon), @dev (technische opmerking), @param en @return. Schrijf alleen wat de code ECHT doet; Gedrag toevoegen dat niet in de code staat. Markeer het effect waarvan u niet zeker bent.
2) Technisch-eenvoudige vertaling:
Leg dit mechanisme in gewoon Turks uit, zodat een beginnende crypto-gebruiker het kan begrijpen: wat doet het, wat moet de gebruiker doen, WELKE RISICO’S zijn er? Overdrijving; geen garantie op veiligheid. Verberg risico’s niet, maar breng ze naar voren.
3) Risico-/waarschuwingssectie:
Schrijf een eerlijke sectie 'Risico's en kanttekeningen' voor dit project: smartcontractrisico, marktrisico, liquiditeitsrisico, onzekerheid over de regelgeving, belangrijk verlies. Leg elk risico in duidelijke taal uit. Onderschat de risico's niet; eindigen met "dit is geen financieel advies."
4) Consistentiecontrole van documentatiecode:
Hieronder vindt u een functie en de beschikbare documentatie. Markeer de plaatsen waar het document het WERKELIJKE gedrag van de code tegenspreekt of weglaat. Definitieve besluitvorming; Dien het in voor 'ontwikkelaarverificatie'.
Drie minikoffers (in aantallen)
Geval 1 — NatSpec heeft de inspectie geïntensiveerd. Eén team diende zonder commentaar een contract met 25 functies ter beoordeling in; De auditor vroeg om extra tijd om de logica te begrijpen. Het team produceerde NatSpec-concepten met AI en bevestigde ze allemaal met code; De auditvoorbereiding werd met bijna 1 dag ingekort. Les: goede documentatie verlaagt de auditkosten.
Geval 2 – Valse bewering betrapt. In de gebruikershandleiding die YZ produceerde, stond dat “uw geld op elk moment kan worden opgenomen”; terwijl er een blokkering van zeven dagen in het contract zat. De technische beoordeling heeft dit opgemerkt. Als het zou worden gepubliceerd, zouden gebruikers zich vergissen en het slachtoffer worden. Les: elke technische claim wordt bevestigd door code.
Geval 3 – Overdrijving opgehelderd. In het eerste concept van de whitepaper gebruikte AI uitdrukkingen als ‘hoog rendement zonder risico’. Het team heeft deze verwijderd en een eerlijk risicogedeelte toegevoegd. Dit beschermde het project zowel ethisch als juridisch. Les: de marketingvoorkeur van AI moet worden gecontroleerd.
Ethische documentatielast
Web3-documentatie wordt gelezen in een context waarin de gebruiker zijn geld riskeert. Daarom:
- Eerlijkheid: Risico's kunnen niet worden verborgen en er kunnen geen overdreven beloftes worden gedaan.
- Nauwkeurigheid: technische claims moeten overeenkomen met de code; ‘Het document zegt het’ is geen verdediging, maar eerder een verkeerde voorstelling van zaken.
- Toegankelijkheid: Schrijven in een taal die de gebruiker daadwerkelijk begrijpt, is een veiligheidsmaatregel; Een document dat niet wordt begrepen, is een uitnodiging tot bedrog.
- Disclaimer: Er moet duidelijk worden vermeld dat het geen financieel advies en onzekerheid over de regelgeving betreft.
Tip: Eerlijkheidstest van een Web3-document: "Als een gebruiker geld investeert in het vertrouwen van alleen dit document, zal hij zich dan bedrogen voelen wanneer hij met de waarheid wordt geconfronteerd?" Laat de AI altijd het risicogedeelte benadrukken, en begraaf het niet aan het eind.
Veel voorkomende fouten
- De technische claim niet bevestigen met code. Het verkeerde document misleidt de gebruiker.
- Het laten vallen van de hype/marketingtaal. Ethisch en juridisch risico.
- Risico’s minimaliseren of verbergen. Schending van vertrouwen.
- Whitepaper afdrukken zonder het echte mechanisme aan de AI te geven. Het produceert verzinsels.
- Het negeren van de waarschuwing "geen financieel advies". Wettelijke verplichting.
- Documentatie niet synchroon houden met code. Wanneer de code verandert, wordt het document misleidend.
Samengevat
- Documentatie is een kwestie van veiligheid en vertrouwen in Web3; Het is het meest productieve gebied van AI.
- De kosten van fouten zijn relatief laag, maar valse technische beweringen en overdrijvingen vormen ernstige risico's.
- Elke technische claim moet worden bevestigd door echte code; Het document vervangt de code niet.
- Risico's moeten eerlijk en prominent worden geschreven; Overdrijving en garantietaal moeten worden verwijderd.
- “Het is geen financieel advies” en waarschuwingen van toezichthouders zijn verplicht.
Applicatie taak
Krijg een slimme contractfunctie. Geef de AI de prompt ‘Generate NatSpec’ en vergelijk de gegenereerde interpretatie regel voor regel met het daadwerkelijke gedrag van de code – zijn er meningsverschillen? Maak vervolgens een "technisch duidelijke vertaling" en een "risico-/waarschuwingssectie" voor dezelfde functie. Zoek en corrigeer minimaal één uitspraak van de AI die overdreven is of de code tegenspreekt.
controlelijst
- [ ] Ik heb elke technische claim bevestigd met daadwerkelijke code.
- [ ] Ik heb de overdrijvingen/garanties verwijderd.
- [ ] Ik heb de risico's eerlijk opgeschreven en benadrukt.
- [ ] Ik gaf de AI het echte mechanisme; Ik liet hem het niet verzinnen.
- [ ] Ik heb de waarschuwing toegevoegd: "Dit is geen financieel advies."
- [ ] Ik heb NatSpec volledig geschreven voor voertuig en besturing.
- [ ] Ik was van plan om de documentatie synchroon te houden met de code.