Toss membuka panduan technical writing

Prinsip inti menulis dokumentasi teknis yang baik

1. Menentukan jenis dokumen

Cara menulis yang lebih efektif berbeda-beda tergantung pada tujuan dokumen

• Dokumen berfokus pada pembelajaran: bertujuan memahami alur saat pertama kali menghadapi teknologi atau alat baru
• Dokumen pemecahan masalah: bertujuan menyelesaikan masalah tertentu ketika sudah memiliki pengetahuan dasar
• Dokumen referensi: bertujuan memeriksa cara penggunaan fitur atau API tertentu meskipun sudah mengetahui cara memakainya
• Dokumen penjelasan: bertujuan memahami konsep, prinsip, dan pengetahuan latar secara mendalam

2. Membangun struktur informasi

Memahami pengetahuan baru memang membutuhkan usaha, tetapi dengan menata informasi secara terstruktur, usaha itu bisa dikurangi

• Bahas hanya satu hal dalam satu halaman
• Berikan nilai terlebih dahulu
• Tulis judul yang efektif
• Jangan lewatkan gambaran umum
• Buat agar mudah diprediksi

3. Memoles kalimat

Jika daya sampaikan kalimat ditingkatkan, pembaca dapat lebih mudah memahami isi. Jika detail disampaikan dengan kalimat yang sulit dipahami, daya penyampaiannya akan sangat menurun

• Perjelas subjek kalimat
• Sisakan hanya informasi yang diperlukan
• Tulis secara konkret
• Gunakan ungkapan bahasa Korea yang alami
• Tulis secara konsisten

[tested]

Apakah ada tempat yang mengumpulkan situs-situs seperti ini yang dibuat oleh Toss?

[dontdieych]

Gaya bahasa dengan akhiran 'yo' memang sulit dibiasakan.

[gera1d]

Itu benar.

[winterjung]

Bagus ya, terutama bagian tentang menyunting kalimat, sepertinya ingin saya coba buat dengan GPTs menggunakan few-shot lalu dipakai.

[mathgig]

Tulisan seperti ini tampaknya bagus. Menurut Anda, di era LLM bagaimana pedoman seperti ini bisa berubah?

[bluejoyq]

Proyek yang sangat bagus ^^