Get best of the week

Cara membuat artikel atau dokumentasi Anda dipahami dengan cepat dan akurat

Tidak hanya konten, tetapi juga struktur teks harus bermakna.

Jadi, jika kita berbicara tentang teks teknis atau ilmiah, misalnya, artikel atau dokumentasi, maka formulir tersebut akan membantu memahami konten dengan cepat dan mudah. Bagi saya, dalam hal artikel, ini berarti strukturnya harus seperti ini:

  • Berita utama
  • Esensi artikel
    Berdasarkan beberapa kalimat berikut, bersama dengan tajuk utama, pembaca harus memahami apakah dia tertarik membaca artikel ini lebih lanjut.
  • Ringkasan
    Di sini, dalam bentuk yang paling ringkas, tesis, tetapi dengan akurasi dan kelengkapan yang diperlukan, esensi artikel ini harus tercermin - dari beberapa kalimat hingga beberapa halaman. Seseorang yang jauh di dalam subjek mungkin cukup untuk memahami seluruh artikel. Tetapi bagaimanapun juga, akan bermanfaat bagi pembaca untuk menyajikan dalam bentuk yang paling umum tentang artikel ini dan kesimpulan apa yang akan diterima pada akhirnya.
  • Logika artikel
    Jika artikelnya panjang, berisi banyak bagian dan logika yang kompleks, maka bab ini juga bisa bermanfaat. Ini pada dasarnya adalah daftar isi yang diperluas. Di sini, secara singkat, pada satu atau dua halaman, logika penalaran dinyatakan secara kering tanpa detail. Sekali lagi, ini akan cukup bagi seseorang untuk memahami segalanya. Jika sulit, maka pembaca dapat melewati ini (sebagai daftar isi) dan membaca terus.
  • Presentasi yang disederhanakan
    Jika artikelnya cukup rumit, maka akan lebih mudah bagi banyak orang untuk terlebih dahulu memahami secara konseptual apa yang ingin penulis katakan. Oleh karena itu, baik untuk menyatakan segala sesuatu terlebih dahulu seolah-olah Anda memberi tahu siswa, kehilangan bukti kompleks, dan mungkin tidak dalam bahasa formal dan ketat seperti itu. Bagi banyak orang, tingkat presentasi ini mungkin cukup, dan mereka akan berhenti di sini.
  • Presentasi yang ketat
    Berikut ini adalah presentasi yang sepenuhnya profesional.

Tentu saja, strukturnya tidak harus seperti itu. Misalnya, tergantung pada kerumitan dan panjang teks, beberapa bagian mungkin berlebihan atau, sebaliknya, dapat ditambahkan, tetapi strukturnya harus sesuai dengan tujuannya. Dalam hal ini, pendekatan yang dinyatakan memungkinkan pembaca untuk memahami konten artikel yang kompleks secepat mungkin dan dengan tingkat kedalaman yang diperlukan. Saya menggunakan pendekatan ini ketika menulis artikel Persamaan Diferensial Nonlinear, diskresi ruang-waktu dan produk epsilon . Anda akan melihat semua item kecuali yang terakhir.

Saya harus membaca banyak dokumentasi teknis. Menurut pendapat saya, organisasi teks yang diterima secara umum tidak nyaman. Saya tidak punya waktu (dan keinginan) untuk menikmati pengembangan plot yang konsisten dan keindahan suku kata, ini bukan "Perang dan Kedamaian", saya hanya butuh informasi dan semakin cepat, semakin baik. Oleh karena itu, dalam hal topik baru dan kompleks, saya harus memindai teks beberapa kali terlebih dahulu untuk mencari makna, kesimpulan dan logika, dan hanya dengan demikian saya dapat melihatnya secara memadai. Faktanya, saya mengikuti pendekatan yang digariskan, tetapi dengan cara yang sangat tidak nyaman dan menghabiskan waktu, dan akan jauh lebih nyaman bagi saya jika informasi itu segera diatur sesuai dengan itu.

More articles:


All Articles