Satuan 8 / 11

Dokumentasi dan Penulisan Teknis: Whitepaper, NatSpec dan Panduan Pengguna

Keuntungan:

  • Mampu menggunakan kecerdasan buatan dengan aman dalam menghasilkan whitepaper, NatSpec, terjemahan teknis-sederhana dan pengungkapan risiko serta pemahaman bahwa ini adalah bidang yang paling produktif.
  • Kemampuan untuk memverifikasi setiap klaim teknis dengan kode aktual dan menghilangkan bahasa yang berlebihan dan garansi untuk menghindari risiko dokumentasi yang salah
  • Kemampuan untuk menerima risiko dengan jujur, peringatan 'bukan nasihat keuangan' dan konsistensi kode dokumentasi

Dokumentasi di Web3 bukanlah suatu kemewahan, tetapi masalah keamanan dan kepercayaan. Dengan berinteraksi dengan kontrak pintar, pengguna mempertaruhkan uang aslinya; Jika dia tidak mengerti apa yang dia lakukan, dia mudah tertipu. Auditor tidak dapat meninjau kode dengan aman jika tidak didokumentasikan dengan baik. Dalam unit ini, kami membahas bidang di mana AI paling andal dan efisien: dokumentasi dan penulisan teknis. Dari whitepaper hingga komentar dalam kode, dari panduan pengguna hingga pengungkapan risiko, AI adalah pengganda kekuatan yang nyata di sini — selama keakuratannya dipantau secara manusiawi.

Jenis dokumentasi Web3

  • Whitepaper / litepaper: Dokumen dasar yang menjelaskan visi, mekanisme dan tokennomics proyek.
  • Dokumentasi teknis: Antarmuka kontrak, panduan integrasi untuk pengembang.
  • NatSpec (Spesifikasi Bahasa Alami Ethereum — Format komentar dalam kode standar dalam Soliditas yang menjelaskan fungsi apa yang dilakukan): Dokumentasi yang tertanam dalam kode, dibaca oleh manusia dan alat.
  • Panduan pengguna: Teks biasa yang memberi tahu pengguna akhir "cara menggunakan, apa risikonya".
  • Penafian: Peringatan yang diwajibkan secara hukum dan etika.

Masalah umum dengan tipe ini: pengembang tidak suka menulis dan sering membiarkannya sampai saat-saat terakhir. AI justru mengisi kesenjangan ini.

Mengapa dokumentasi adalah area AI yang paling aman

Biaya kesalahan dalam dokumentasi lebih rendah dibandingkan dalam audit: satu kalimat yang salah dikoreksi, tidak ada uang yang terbang (secara langsung). Selain itu, AI secara alami kuat dalam produksi bahasa. Jadi AI efisien dan relatif aman di sini. Namun masih ada dua risiko penting:

  1. Klaim teknis yang salah: AI mungkin salah menggambarkan fungsi kode; Hal ini menyesatkan pengguna dan dapat menjadi kerentanan keamanan (kecuali jika dikatakan "fungsi ini melindungi dana Anda" padahal tidak).
  2. Hiperbola/bahasa pemasaran: AI dapat menghasilkan bahasa yang membuat proyek tampak aman atau menguntungkan; Ini merupakan masalah etika dan hukum.
Perhatian: Dokumentasi menjelaskan kodenya; Itu bukan kode itu sendiri. Setiap pernyataan teknis yang ditulis AI ("ini terjadi", "yang dipertahankan") harus diverifikasi dengan kode sebenarnya. Dokumentasi yang salah bisa lebih berbahaya daripada kode yang benar karena pengguna mempercayai dokumentasi tersebut.

Lapisan penggunaan AI dalam dokumentasi

1. Generasi NatSpec. AI membaca fungsi yang ada dan menyusun interpretasi NatSpec: apa yang dilakukannya, apa parameternya, apa yang dikembalikannya. Ini menyederhanakan pemeriksaan dan pemeliharaan.

2. Terjemahan teknis-sederhana. AI menerjemahkan mekanisme kompleks ke dalam bahasa yang dapat dipahami oleh pengguna akhir — salah satu kebutuhan terbesar Web3.

3. Garis besar dan struktur whitepaper. AI menghasilkan kerangka dan bagian dari whitepaper; Akurasi konten adalah hal yang manusiawi.

4. Multilingualisme dan penyesuaian level. AI dapat menghasilkan konten yang sama, baik teknis maupun sederhana, dalam bahasa Turki dan Inggris.

Perintah lemah / Perintah kuat

Perintah yang lemah:

Tulis whitepaper untuk proyek ini.

AI membuat salinan yang berlebihan, mungkin palsu, dan berisi pemasaran tanpa mengetahui mekanisme sebenarnya.

Perintah yang kuat:

Peran Anda: penulis teknis Web3. Di bawah ini adalah mekanisme NYATA, tokenomik, dan kode proyek. Tulis draf whitepaper hanya berdasarkan informasi ini. Aturan: - Jangan melebih-lebihkan, JANGAN menggunakan frasa seperti "keuntungan terjamin", "aman sepenuhnya", dll. - Dasarkan setiap klaim teknis pada mekanisme yang saya berikan; Jangan tambahkan fabrikasi.- Tambahkan bagian "Risiko" yang dengan jelas menyatakan risikonya.- Tambahkan peringatan "Ini bukan nasihat keuangan." Tandai informasi apa pun yang Anda tidak yakin atau tidak saya miliki sebagai [HARUS DIISI].

Empat templat yang dapat disalin

1) generasi NatSpec:

Tulis komentar NatSpec standar ke fungsi berikut: @notice (apa fungsinya, biasa saja), @dev (catatan teknis), @param, dan @return. Tulis hanya apa yang SEBENARNYA dilakukan oleh kode tersebut; Menambahkan perilaku yang tidak ada dalam kode. Tandai efek yang Anda tidak yakin.

2) Terjemahan teknis-sederhana:

Jelaskan mekanisme ini dalam bahasa Turki sederhana yang dapat dipahami oleh pengguna kripto pemula: apa fungsinya, apa yang harus dilakukan pengguna, APA RISIKO yang ada? Berlebihan; tidak ada jaminan keamanan. Jangan sembunyikan risiko, tampilkan risiko tersebut.

3) Bagian risiko/peringatan:

Tuliskan bagian "Risiko dan Peringatan" yang jujur ​​untuk proyek ini: risiko kontrak pintar, risiko pasar, risiko likuiditas, ketidakpastian peraturan, kerugian utama. Jelaskan setiap risiko dengan bahasa yang sederhana. Jangan meremehkan risikonya; diakhiri dengan "ini bukan nasihat keuangan".

4) Pemeriksaan konsistensi kode dokumentasi:

Di bawah ini adalah fungsi dan dokumentasi yang tersedia. Tandai tempat-tempat di mana dokumen tersebut bertentangan atau menghilangkan perilaku SEBENARNYA dari kode tersebut. Pengambilan keputusan akhir; Kirimkan untuk "verifikasi pengembang".

Tiga kotak mini (dalam jumlah)

Kasus 1 — NatSpec meningkatkan pemeriksaan. Satu tim menyerahkan kontrak 25 fungsi untuk ditinjau tanpa komentar; Auditor meminta waktu tambahan untuk memahami logikanya. Tim membuat draf NatSpec dengan AI dan mengonfirmasi setiap draf dengan kode; Persiapan audit dipersingkat hampir 1 hari. Pelajaran: dokumentasi yang baik mengurangi biaya audit.

Kasus 2 — Klaim palsu tertangkap. Panduan pengguna yang dibuat YZ menyatakan bahwa “dana Anda dapat ditarik kapan saja”; padahal ada kuncian 7 hari dalam kontrak. Tinjauan teknis menangkap hal ini. Jika dipublikasikan, pengguna akan disalahgunakan dan menjadi korban. Pelajaran: setiap klaim teknis dikonfirmasi oleh kode.

Kasus 3 - Sikap berlebihan telah teratasi. Dalam draf whitepaper pertama, AI menggunakan ungkapan seperti "pengembalian tinggi tanpa risiko". Tim menghapus ini dan menambahkan bagian risiko yang jujur. Hal ini melindungi proyek baik secara etika maupun hukum. Pelajaran: Bias pemasaran AI harus diaudit.

Beban etis dokumentasi

Dokumentasi Web3 dibaca dalam konteks di mana pengguna mempertaruhkan uangnya. Oleh karena itu:

  • Kejujuran: Resiko tidak dapat disembunyikan dan janji yang berlebihan tidak dapat dibuat.
  • Akurasi: Klaim teknis harus sesuai dengan kode; “Dokumen tersebut mengatakan demikian” bukanlah suatu pembelaan, melainkan suatu penafsiran yang keliru.
  • Aksesibilitas: Menulis dalam bahasa yang benar-benar dipahami pengguna merupakan tindakan pengamanan; Dokumen yang tidak dipahami adalah ajakan untuk melakukan penipuan.
  • Penafian: Harus dinyatakan dengan jelas bahwa ini bukan nasihat keuangan dan ketidakpastian peraturan.
Tip: Uji kejujuran dokumen Web3: "Jika pengguna mengeluarkan uang hanya untuk mempercayai dokumen ini, apakah dia akan merasa tertipu saat dihadapkan pada kebenaran?" Selalu minta AI menyoroti bagian risikonya, bukan menguburnya di akhir.

Kesalahan umum

  • Tidak mengonfirmasi klaim teknis dengan kode. Dokumen yang salah menyesatkan pengguna.
  • Menghilangkan bahasa hype/pemasaran. Risiko etika dan hukum.
  • Meminimalkan atau menyembunyikan risiko. Pelanggaran kepercayaan.
  • Mencetak whitepaper tanpa memberikan mekanisme sebenarnya kepada AI. Ini menghasilkan fabrikasi.
  • Mengabaikan peringatan "bukan nasihat keuangan". Kewajiban hukum.
  • Tidak menyinkronkan dokumentasi dengan kode. Ketika kode berubah, dokumen menjadi menyesatkan.

Singkatnya

  • Dokumentasi adalah masalah keamanan dan kepercayaan pada Web3; Ini adalah bidang AI yang paling produktif.
  • Kerugian akibat kesalahan relatif rendah, namun klaim teknis yang salah dan pernyataan yang berlebihan merupakan risiko yang serius.
  • Setiap klaim teknis harus dikonfirmasi dengan kode asli; Dokumen tersebut tidak menggantikan kode.
  • Risiko harus ditulis secara jujur ​​dan jelas; Bahasa yang berlebihan dan penuh jaminan harus dihilangkan.
  • “Ini bukan nasihat keuangan” dan peringatan peraturan bersifat wajib.

Tugas aplikasi

Dapatkan fungsi kontrak pintar. Berikan perintah “Hasilkan NatSpec” kepada AI dan bandingkan interpretasi yang dihasilkan baris demi baris dengan perilaku kode yang sebenarnya — apakah ada perbedaan pendapat? Kemudian buatlah "terjemahan teknis-jelas" dan "bagian risiko/peringatan" untuk fungsi yang sama. Temukan dan perbaiki setidaknya satu pernyataan AI yang berlebihan atau bertentangan dengan kode.

daftar periksa

  • [ ] Saya mengonfirmasi setiap klaim teknis dengan kode sebenarnya.
  • [ ] Saya menghapus pernyataan yang berlebihan/jaminan.
  • [ ] Saya menulis risikonya dengan jujur ​​dan menyorotinya.
  • [ ] Saya memberi AI mekanisme sebenarnya; Aku tidak membiarkan dia menebusnya.
  • [ ] Saya menambahkan peringatan "Ini bukan nasihat keuangan."
  • [ ] Saya menulis NatSpec secara lengkap untuk kendaraan dan kontrol.
  • [] Saya berencana untuk menyinkronkan dokumentasi dengan kode.