Keuntungan:
- Mampu menggunakan kecerdasan buatan dengan selamat dalam menghasilkan kertas putih, NatSpec, terjemahan ringkas teknikal dan pendedahan risiko serta memahami bahawa ini adalah bidang yang paling produktif.
- Keupayaan untuk mengesahkan setiap tuntutan teknikal dengan kod sebenar dan menghapuskan keterlaluan dan bahasa jaminan untuk mengelakkan risiko dokumentasi yang salah
- Keupayaan untuk menerima risiko secara jujur, amaran 'bukan nasihat kewangan' dan konsistensi kod dokumentasi
Dokumentasi dalam Web3 bukanlah satu kemewahan, tetapi soal keselamatan dan kepercayaan. Dengan berinteraksi dengan kontrak pintar, pengguna mempertaruhkan wang sebenarnya; Jika dia tidak faham apa yang dia lakukan, dia terbuka untuk ditipu. Juruaudit tidak boleh menyemak kod yang tidak didokumenkan dengan baik. Dalam unit ini, kami meliputi kawasan di mana AI paling dipercayai dan cekap: dokumentasi dan penulisan teknikal. Daripada kertas putih kepada komen dalam kod, daripada panduan pengguna kepada pendedahan risiko, AI ialah pengganda daya sebenar di sini — selagi ketepatan dipantau secara manusiawi.
Jenis dokumentasi Web3
- Kertas putih / litepaper: Dokumen asas yang menerangkan visi, mekanisme dan tokenomik projek.
- Dokumentasi teknikal: Antara muka kontrak, panduan penyepaduan untuk pembangun.
- NatSpec (Spesifikasi Bahasa Asli Ethereum — Format komen dalam kod standard dalam Solidity yang menerangkan fungsi yang dilakukan): Dokumentasi dibenamkan dalam kod, dibaca oleh manusia dan alat.
- Panduan pengguna: Teks biasa memberitahu pengguna akhir "cara menggunakan, apakah risiko yang ada".
- Penafian: Amaran yang diperlukan dari segi undang-undang dan etika.
Masalah biasa dengan jenis ini: pembangun tidak suka menulis dan sering meninggalkannya pada saat terakhir. AI mengisi jurang ini dengan tepat.
Mengapa dokumentasi adalah kawasan AI yang paling selamat
Kos kesilapan dalam dokumentasi adalah lebih rendah daripada pengauditan: satu ayat yang salah diperbetulkan, tiada wang terbang (secara langsung). Selain itu, AI sememangnya kuat dalam penghasilan bahasa. Jadi AI adalah cekap dan agak selamat di sini. Tetapi dua risiko kritikal kekal:
- Tuntutan teknikal palsu: AI mungkin salah nyatakan perkara yang dilakukan oleh kod; Ini mengelirukan pengguna dan boleh menjadi kelemahan keselamatan (melainkan ia mengatakan "fungsi ini melindungi dana anda" dan tidak).
- Bahasa hiperbola/pemasaran: AI boleh menghasilkan bahasa yang menjadikan projek kelihatan selamat atau menguntungkan; Ini adalah masalah etika dan undang-undang.
Awas: Dokumentasi menerangkan kod; Ia bukan kod itu sendiri. Setiap penegasan teknikal yang ditulis AI ("ini berlaku", "yang dikekalkan") mesti disahkan terhadap kod sebenar. Dokumentasi yang salah boleh menjadi lebih berbahaya daripada kod yang betul kerana pengguna mempercayai dokumentasi.
Lapisan penggunaan AI dalam dokumentasi
1. Penjanaan NatSpec. AI membaca fungsi sedia ada dan mendraf tafsiran NatSpec: apa yang ia lakukan, apakah parameternya, apa yang ia kembalikan. Ini memudahkan pemeriksaan dan penyelenggaraan.
2. Terjemahan teknikal-mudah. AI menterjemah mekanisme kompleks ke dalam bahasa yang boleh difahami oleh pengguna akhir — salah satu keperluan terbesar Web3.
3. Garis dan struktur kertas putih. AI menghasilkan rangka dan bahagian kertas putih; Ketepatan kandungan adalah manusia.
4. Multilingualisme dan pelarasan tahap. AI boleh menghasilkan kandungan yang sama, teknikal dan biasa, dalam kedua-dua bahasa Turki dan Inggeris.
Gesaan lemah / Gesaan kuat
Gesaan yang lemah:
Tulis kertas putih untuk projek ini.
AI menghasilkan salinan yang dibesar-besarkan, mungkin palsu, dan penuh pemasaran tanpa mengetahui mekanisme sebenar.
Gesaan kuat:
Peranan anda: Penulis teknikal Web3. Di bawah ialah mekanisme REAL, tokenomics dan kod projek. Tulis draf kertas putih berdasarkan maklumat ini sahaja. Peraturan:- Jangan keterlaluan, JANGAN gunakan frasa seperti "untung terjamin", "selamat sepenuhnya" dsb.- Asaskan setiap tuntutan teknikal pada mekanisme yang saya berikan; Jangan tambah rekaan.- Tambah bahagian "Risiko" yang menyatakan risiko dengan jelas.- Tambah amaran "Ini bukan nasihat kewangan." Tandai sebarang maklumat yang anda tidak pasti atau yang saya tidak ada sebagai [UNTUK DIISI].
Empat templat yang boleh disalin
1) Penjanaan NatSpec:
Tulis ulasan NatSpec standard kepada fungsi berikut: @notis (apa yang dilakukan, biasa), @dev (nota teknikal), @param dan @return. Tulis hanya apa yang kod SEBENARNYA lakukan; Menambah tingkah laku yang tiada dalam kod. Tandakan kesan yang anda tidak pasti.
2) Terjemahan mudah teknikal:
Terangkan mekanisme ini dalam bahasa Turki biasa yang boleh difahami oleh pengguna pemula kripto: apa yang ia lakukan, apa yang perlu dilakukan oleh pengguna, APA RISIKO yang ada? Keterlaluan; tiada jaminan keselamatan. Jangan sembunyikan risiko, bawa mereka ke hadapan.
3) Bahagian risiko/amaran:
Tulis bahagian "Risiko dan Kaveat" yang jujur untuk projek ini: risiko kontrak pintar, risiko pasaran, risiko kecairan, ketidakpastian peraturan, kerugian utama. Terangkan setiap risiko dalam bahasa biasa. Jangan memandang rendah risiko; berakhir dengan "ini bukan nasihat kewangan."
4) Semakan konsistensi kod dokumentasi:
Di bawah ialah fungsi dan dokumentasinya yang tersedia. Tandai tempat di mana dokumen itu bercanggah atau meninggalkan kelakuan SEBENAR kod tersebut. Membuat keputusan akhir; Serahkannya untuk "pengesahan pembangun".
Tiga kes mini (dalam bilangan)
Kes 1 — NatSpec meningkatkan pemeriksaan. Satu pasukan menyerahkan kontrak 25 fungsi untuk semakan tanpa komen; Juruaudit meminta masa tambahan untuk memahami logik. Pasukan itu menghasilkan draf NatSpec dengan AI dan mengesahkan setiap satu dengan kod; Persediaan audit dipendekkan hampir 1 hari. Pengajaran: dokumentasi yang baik mengurangkan kos audit.
Kes 2 — Tuntutan palsu ditangkap. Manual pengguna yang YZ hasilkan menyatakan bahawa "dana anda boleh dikeluarkan pada bila-bila masa"; sedangkan terdapat penguncian 7 hari dalam kontrak. Kajian teknikal mendapati ini. Jika ia diterbitkan, pengguna akan tersilap dan menjadi mangsa. Pelajaran: setiap tuntutan teknikal disahkan oleh kod.
Kes 3 — Keterlaluan diselesaikan. Dalam draf kertas putih pertama, AI menggunakan ungkapan seperti "pulangan tinggi tanpa risiko". Pasukan mengalih keluar ini dan menambah bahagian risiko yang jujur. Ini melindungi projek secara beretika dan sah. Pengajaran: Kecondongan pemasaran AI mesti diaudit.
Beban etika dokumentasi
Dokumentasi Web3 dibaca dalam konteks di mana pengguna mempertaruhkan wang mereka. Oleh itu:
- Kejujuran: Risiko tidak boleh disembunyikan dan janji yang dibesar-besarkan tidak boleh dibuat.
- Ketepatan: Tuntutan teknikal mesti sepadan dengan kod; "Dokumen itu berkata demikian" bukanlah pembelaan, sebaliknya merupakan salah nyata.
- Kebolehcapaian: Menulis dalam bahasa yang sebenarnya difahami oleh pengguna ialah langkah keselamatan; Dokumen yang tidak difahami adalah jemputan untuk penipuan.
- Penafian: Perlu dinyatakan dengan jelas bahawa ia bukan nasihat kewangan dan ketidakpastian peraturan.
Petua: Ujian kejujuran dokumen Web3: "Jika pengguna meletakkan wang untuk mempercayai dokumen ini sahaja, adakah dia akan berasa tertipu apabila berhadapan dengan kebenaran?" Sentiasa pastikan AI menyerlahkan bahagian risiko, bukan membenamkannya pada penghujungnya.
Kesilapan biasa
- Tidak mengesahkan tuntutan teknikal dengan kod. Dokumen yang salah mengelirukan pengguna.
- Menggugurkan bahasa gembar-gembur/pemasaran. Risiko etika dan undang-undang.
- Meminimumkan atau menyembunyikan risiko. Pecah amanah.
- Mencetak kertas putih tanpa memberikan mekanisme sebenar kepada AI. Ia menghasilkan fabrikasi.
- Mengabaikan amaran "bukan nasihat kewangan". Kewajipan undang-undang.
- Tidak memastikan dokumentasi selari dengan kod. Apabila kod berubah, dokumen menjadi mengelirukan.
Secara ringkasnya
- Dokumentasi adalah soal keselamatan dan kepercayaan dalam Web3; Ia adalah bidang AI yang paling produktif.
- Kos kesilapan agak rendah, tetapi tuntutan teknikal palsu dan keterlaluan adalah risiko yang serius.
- Setiap tuntutan teknikal mesti disahkan oleh kod sebenar; Dokumen tidak menggantikan kod.
- Risiko hendaklah ditulis dengan jujur dan jelas; Bahasa yang keterlaluan dan jaminan harus dibuang.
- "Ia bukan nasihat kewangan" dan amaran peraturan adalah wajib.
Tugasan permohonan
Dapatkan fungsi kontrak pintar. Berikan gesaan "Jana NatSpec" kepada AI dan bandingkan tafsiran yang dihasilkan baris demi baris dengan kelakuan sebenar kod — adakah terdapat sebarang perselisihan faham? Kemudian hasilkan "terjemahan teknikal-biasa" dan "bahagian risiko/amaran" untuk fungsi yang sama. Cari dan betulkan sekurang-kurangnya satu pernyataan AI yang dibesar-besarkan atau bercanggah dengan kod.
senarai semak
- [ ] Saya mengesahkan setiap tuntutan teknikal dengan kod sebenar.
- [ ] Saya mengalih keluar keterlaluan/jaminan.
- [ ] Saya menulis risiko dengan jujur dan menyerlahkannya.
- [ ] Saya memberikan AI mekanisme sebenar; Saya tidak benarkan dia mengada-ada.
- [ ] Saya menambah amaran "Ini bukan nasihat kewangan."
- [ ] Saya menulis NatSpec sepenuhnya untuk kenderaan dan kawalan.
- [ ] Saya merancang untuk memastikan dokumentasi selari dengan kod.