Cara buat whitepaper crypto: ubah fakta proyek menjadi dokumen yang mudah dibaca

Apa yang harus bisa diverifikasi pembaca dari bagian pembuka?

Pernyataan tujuan satu kalimat memberi pembaca ujian untuk seluruh dokumen. Pernyataan tersebut harus mengidentifikasi proyek, pembaca yang dituju, dan keputusan atau pemahaman yang didukung dokumen. Jaga tujuan tersebut spesifik untuk produk, bukan janji luas tentang pasar.

Sebelum menulis, pilih pembaca utama. Pengembang mungkin membutuhkan perilaku komponen dan asumsi integrasi. Calon pengguna mungkin membutuhkan alur produk dan batasannya saat ini. Pemegang token mungkin membutuhkan fungsi token yang terdokumentasi dan aturan tata kelola. Dokumen dapat melayani beberapa kelompok, tetapi sebutkan audiens pertama dan urutkan detailnya sesuai.

Buat catatan awal singkat dengan 4 pertanyaan ini:

• Masalah apa yang diatasi proyek, dan untuk siapa?
• Apa yang bisa dilakukan pengguna atau pengembang saat ini?
• Kemampuan mana yang masih diusulkan atau dalam pengembangan?
• Apa yang harus bisa dinilai pembaca setelah membaca?

Tandai setiap jawaban sebagai langsung, teruji, direncanakan, atau belum terselesaikan. Kosakata status itu membantu mencegah item peta jalan terbaca seperti fitur yang tersedia. Jika proyek masih awal, nyatakan apa yang masih belum diketahui. Kemudian gunakan pernyataan tujuan untuk menghapus bagian yang tidak membantu pembaca yang disebutkan memahami atau menilai proyek.

Bagian mana yang termasuk dalam peta dokumen whitepaper?

Garis besar 7 bagian dapat menggerakkan pembaca dari masalah proyek ke pertanyaan terbukanya. Anggap sebagai peta kerja, bukan templat wajib. Tambahkan bagian hanya jika menjelaskan sesuatu yang material tentang proyek ini.

Urutan yang berguna adalah:

• Ringkasan: masalah, pendekatan, dan status pengembangan saat ini.
• Masalah dan konteks: siapa yang menghadapi masalah dan apa yang masih belum terselesaikan oleh pendekatan yang ada.
• Produk atau protokol: komponen, alur pengguna, dan batasan sistem.
• Desain teknis: arsitektur yang relevan, dependensi, dan asumsi keamanan.
• Desain token, jika berlaku: fungsi, aturan pasokan, alokasi, dan mekanisme tata kelola.
• Peta jalan dan tanggung jawab: pekerjaan yang direncanakan, pemilik keputusan, dan dependensi.
• Risiko dan pertanyaan terbuka: batasan yang diketahui dan pilihan desain yang belum terselesaikan.

Jangan menambahkan ekonomi token ke proyek tanpa token. Untuk proyek token, jangan mengubur mekanisme inti di lampiran. Tempatkan penjelasan singkat sebelum detail spesialis. Gunakan lampiran untuk materi yang mendukung klaim tetapi mengganggu penjelasan utama.

Untuk perencanaan peluncuran yang melampaui dokumen ini, lihat daftar periksa token launch. Jaga fakta proyeknya selaras dengan whitepaper. Untuk gambaran terpisah tentang persiapan listing, konsultasikan panduan listing CoinMarketCap dan listing CoinGecko. Sumber daya tersebut menangani tugas yang berbeda; tidak boleh digunakan sebagai bukti bahwa suatu proyek memenuhi persyaratan platform.

Bagaimana pembaca bisa melacak klaim ke sumbernya?

Inventaris klaim menunjukkan pernyataan mana yang perlu verifikasi sebelum prosa dirapikan. Buat untuk setiap pernyataan penting tentang perilaku produk, mekanisme token, asumsi keamanan, atau status proyek. Catatan itu membuat celah terlihat saat draf masih mudah diubah.

Gunakan 4 bidang untuk setiap entri: klaim persis, sumber atau asumsi yang dinyatakan, status, dan peninjau. Review default kami menggunakan 3 titik periksa: kecocokan sumber, kecocokan status, dan tanda tangan pemilik. Manual produk dapat mendukung deskripsi alur pengguna. Catatan desain dapat menjelaskan keputusan arsitektur. Perkiraan harus diidentifikasi sebagai estimasi, bukan disajikan sebagai hasil yang diamati. Jika tidak ada materi pendukung, kualifikasikan pernyataan atau hapus.

Bagian token membutuhkan definisi yang tepat. Jelaskan apa arti setiap istilah pasokan dan bagaimana aturan alokasi atau pelepasan bekerja. Identifikasi aturan mana yang didokumentasikan dan mana yang dapat berubah melalui tata kelola atau proses lain yang dinyatakan. Jangan menyiratkan bahwa memegang token memberikan hak kecuali persyaratan proyek mendukung pembacaan itu.

Catatan ini juga membantu editor masa depan menemukan teks yang terpengaruh oleh perubahan produk. Bandingkan entrinya dengan materi proyek saat ini dan dengan daftar periksa token launch. Di GeoMarketing Experts, peninjau dapat mengembalikan draf yang ditandai dengan pertanyaan yang dikelompokkan berdasarkan pemilik. Untuk keterlibatan penulisan, lihat penulisan whitepaper dan litepaper; untuk lingkup pekerjaan berbayar, lihat harga whitepaper crypto.

Berapa banyak detail teknis yang harus ada di dokumen utama?

Diagram sistem dan keterangannya harus menceritakan kisah yang sama dengan prosa. Gunakan detail teknis untuk menunjukkan bagaimana komponen berinteraksi dan asumsi apa yang mendasari perilakunya. Daftar rantai, kontrak, atau istilah kriptografi saja tidak cukup tanpa hubungan tersebut.

Mulailah dengan gambaran sistem dalam bahasa sederhana. Kemudian jelaskan setiap komponen penting berdasarkan peran, masukan, keluaran, dan dependensinya. Untuk proses multi-aktor, identifikasi siapa yang memulai tindakan, apa yang diperiksa sistem, dan apa yang terjadi ketika dependensi tidak tersedia. Definisikan istilah spesialis pada penggunaan pertama. Pertahankan satu istilah terikat pada satu makna di seluruh dokumen.

Gunakan diagram untuk menunjukkan alur, batas kepercayaan, atau pergerakan data. Tambahkan keterangan yang menyebutkan apa yang disertakan dan dikecualikan dalam gambar. Diagram tidak boleh menyarankan bahwa proses off-chain ditegakkan oleh kontrak pintar. Tautkan ke dokumentasi teknis yang lebih dalam ketika pembaca membutuhkan detail implementasi di luar tujuan dokumen.

Jalankan 2 pemeriksaan pada setiap diagram penting: konfirmasi labelnya cocok dengan teks, lalu minta peninjau teknis memverifikasi perilaku yang digambarkan. Catat 4 bidang untuk setiap diagram: tujuan, komponen, batasan, dan peninjau. Tandai komponen sebagai teruji, diaudit, atau diusulkan hanya jika bukti proyek mendukung label tersebut. Deskripsi itu tidak dapat dipertukarkan. Jika desain berubah, identifikasi detail mana yang bersifat sementara alih-alih menulisnya sebagai fakta yang sudah pasti.

Pemeriksaan penyuntingan mana yang mengungkap celah dalam whitepaper crypto?

Kontradiksi antara deskripsi token dan peta jalan adalah cacat konten, bukan masalah gaya. Tinjau status, definisi, dan bukti sebelum menghabiskan waktu untuk pemolesan kalimat. Pemeriksaan ini membuat draf lebih mudah dinilai:

• Janji tanpa mekanisme: jelaskan sistem dan dependensinya alih-alih menegaskan hasil.
• Rencana ditulis sebagai pengiriman: beri label pekerjaan masa depan dan bedakan dari fungsionalitas yang tersedia.
• Fungsi token yang tidak jelas: jelaskan apa yang dilakukan token dalam sistem.
• Angka atau istilah yang tidak ditentukan: sebutkan apa yang dirujuk oleh setiap nilai atau label.
• Kosakata teknis tanpa konteks: definisikan istilah dan jelaskan mengapa itu penting.
• Nama atau aturan yang bertentangan: bandingkan deskripsi pasokan, peran tata kelola, dan label status di seluruh bagian.
• Bagian generik: hapus bahasa yang tidak menjelaskan desain atau tanggung jawab proyek ini.

Untuk setiap bagian, tanyakan apa yang bisa diverifikasi oleh pembaca yang cermat dari isinya. Tambahkan sumber, kualifikasikan asumsi, atau revisi pernyataan ketika jawabannya tidak jelas. Kemudian lakukan penyuntingan terpisah untuk urutan dan keterbacaan. Memisahkan pemeriksaan fakta dari penyuntingan naskah mengurangi risiko bahwa redaksi yang lebih halus menyembunyikan klaim yang belum terselesaikan.

Bagaimana seharusnya peninjau mencatat perubahan sebelum rilis?

Log perubahan memberi tim catatan tentang apa yang berubah dan mengapa. Tetapkan review berdasarkan subjek: insinyur memeriksa deskripsi sistem, pemilik token memeriksa mekanisme, dan peninjau editorial memeriksa struktur dan konsistensi. Penasihat hukum harus meninjau bahasa yang membutuhkan penilaian hukum.

Gunakan urutan ini:

• Bekukan garis besar dan kumpulkan materi sumber saat ini.
• Tulis penjelasan dan petakan klaim material ke bukti.
• Arahkan setiap klaim ke orang yang bertanggung jawab untuk memeriksanya.
• Selesaikan komentar dan catat alasan perubahan substantif.
• Periksa tautan, diagram, istilah, dan label versi terhadap teks akhir.

Dokumen yang ditandai dengan pertanyaan yang dikelompokkan berdasarkan pemilik memberikan jalur yang jelas untuk revisi berikutnya. Ini membantu pendiri menyelesaikan ruang lingkup dan status, sementara peninjau teknis fokus pada deskripsi sistem. Simpan log perubahan hingga publikasi sehingga peninjau dapat melihat klaim mana yang berpindah dan mengapa.

Untuk komunikasi proyek di luar whitepaper, bandingkan dokumen dengan panduan crypto marketing dan materi teknis proyek saat ini. Jangan gunakan salah satunya sebagai pengganti pemeriksaan fakta sumber. Di GeoMarketing Experts, review draf memetakan klaim material ke buktinya dan mengembalikan pertanyaan berdasarkan pemilik. Kirim garis besar saat ini, dokumentasi produk, materi token jika relevan, dan klaim apa pun yang perlu ditinjau untuk mendiskusikan dukungan penulisan whitepaper.

Apa yang tidak terbukti dari whitepaper yang sudah diterbitkan?

Label versi dan pemilik yang ditugaskan membantu pembaca mengidentifikasi dokumen mana yang mereka baca. Jaga jalur dari dokumen ke dokumentasi proyek saat ini. Tinjau whitepaper ketika fitur material, aturan token, proses tata kelola, atau status proyek berubah. Jika tidak lagi mencerminkan proyek, perbarui atau tandai sebagai usang.

Dokumen formal tidak dapat menetapkan bahwa implementasi berperilaku seperti yang dijelaskan atau mensertifikasi keamanan. Ketentuan token dan tata kelola juga tetap tunduk pada aturan proyek yang terdokumentasi. Nyatakan asumsi dan dependensi yang belum terselesaikan dalam whitepaper, kemudian cari review teknis dan hukum yang berkualifikasi untuk pertanyaan yang tidak dapat diselesaikan oleh materi tersebut.

Sebelum publikasi, periksa bahwa teks akhir sesuai dengan produk dan dokumen yang mengatur. Konfirmasi bahwa diagram, terminologi, label versi, dan tautan cocok dengan draf yang ditinjau. Beri tanggung jawab kepada anggota tim yang disebutkan untuk pembaruan di masa mendatang daripada berasumsi bahwa dokumen akan tetap terkini dengan sendirinya.

Untuk memulai draf, kumpulkan garis besar, dokumentasi produk saat ini, materi token jika relevan, dan daftar klaim yang perlu ditinjau. Kirim item tersebut ke GeoMarketing Experts. Langkah selanjutnya adalah pemeriksaan klaim-ke-sumber, diikuti dengan daftar celah untuk orang yang bertanggung jawab menyelesaikan setiap pertanyaan.

Cara kerja

1. Tetapkan pembaca dan tujuanSebutkan audiens utama dan apa yang harus bisa dinilai pembaca dari dokumen. Pisahkan tugas itu dari pemasaran, persyaratan hukum, dan dokumentasi teknis yang mendetail.
2. Kumpulkan dan beri label fakta saat iniKumpulkan materi produk, arsitektur, token, dan peta jalan. Tandai setiap item sebagai langsung, teruji, direncanakan, atau belum terselesaikan.
3. Petakan bagian dan klaimAtur garis besar di sekitar kebutuhan pembaca. Catat sumber dan peninjau untuk setiap klaim penting.
4. Tulis penjelasanJelaskan sistem dalam bahasa sederhana sebelum menambahkan detail implementasi. Beri keterangan diagram dan identifikasi batasannya.
5. Tinjau dan pelihara whitepaperArahkan klaim ke peninjau yang tepat, selesaikan kontradiksi, dan tetapkan pemilik untuk pembaruan di masa mendatang.