Tips untuk Menulis Makalah Teknis

Tips untuk Menulis Makalah Teknis

Jennifer Widom , Januari 2006

Berikut adalah catatan dari presentasi saya berikan di Stanford InfoLab Jumat siang, 1/27/06, dengan beberapa (tidak banyak) revisi ketika saya reprised bicara pada 12/4/09, dan tidak ada revisi untuk 10/19 / 12 kebangunan rohani. Presentasi meliputi:

• Kertas Judul


• The Abstrak


• Pendahuluan


• Kerja Terkait


• Tubuh


• Percobaan Kinerja


• Kesimpulan


• Kerja Masa Depan


• Para Ucapan Terima Kasih


• Kutipan


• Lampiran


• Grammar dan Isu Presentasi Kecil


• Mekanika


• Versi dan Distribusi 

Menjalankan Contoh

Sebagai berjalan (fictitious!) contoh, misalkan Anda telah merancang
dan menjalankan percobaan dengan algoritma baru untuk multipass
eksternal merge-macam. Algoritma Anda mengurangi kompleksitas dari O (n log n) ke O (n), di bawah premis bahwa hal itu dapat diterima untuk memiliki beberapa bounded "unsortedness" dalam hasil. Anda berencana untuk menuliskan hasil untuk diserahkan kepada sebuah konferensi besar.



Catatan: Contoh ini digunakan di seluruh presentasi hidup tapi saya belum ditindaklanjuti banyak catatan ini. Dengan demikian, catatan termasuk beberapa latihan bagi pembaca.





Kertas Judul

Judul bisa panjang dan deskriptif:

• Linear-Time Multipass Sorting Eksternal dengan Jaminan Aproksimasi

atau pendek dan manis:

• Perkiraan Eksternal Sortir

Berikut adalah tengah-of-jalan-panjang, ditambah nama lucu yang menempel dalam pikiran orang:

• Floosh: Sebuah Algoritma Linear-Time untuk Perkiraan Eksternal Sortir

The Abstrak

Sebutkan masalah, pendekatan dan solusi, dan kontribusi utama kertas. Sertakan sedikit jika ada latar belakang dan motivasi. Jadilah faktual namun komprehensif. Materi dalam abstrak tidak harus diulang kata kemudian untuk kata di koran.

(Latihan: Menulis abstrak untuk jenis contoh multiway.)



Pendahuluan

Pendahuluan adalah sangat penting.
Pada saat wasit telah selesai Pendahuluan, dia mungkin membuat
keputusan awal tentang apakah akan menerima atau menolak kertas - dia
akan membaca sisa kertas mencari bukti untuk mendukung keputusannya. Seorang pembaca kasual akan melanjutkan jika Pendahuluan terpikat padanya, dan akan mengatur kertas samping sebaliknya. Sekali lagi, Pendahuluan adalah sangat penting.

Berikut adalah Stanford InfoLab dipatenkan struktur lima-titik 's untuk Introduksi. Kecuali ada argumen yang baik terhadap hal itu, Pendahuluan harus terdiri dari lima paragraf menjawab lima pertanyaan berikut:

1. Apa masalahnya? 


2. Kenapa menarik dan penting? 


3. Mengapa sulit? (Misalnya, mengapa pendekatan naif gagal?) 


4. Mengapa bukan diselesaikan sebelumnya? (Atau, apa yang salah dengan solusi yang diusulkan sebelumnya? Bagaimana saya berbeda?) 


5. Apa saja komponen kunci dari pendekatan saya dan hasilnya? Juga termasuk batasan tertentu.

  

(Latihan: Jawablah pertanyaan-pertanyaan untuk jenis contoh multiway.)



Kemudian memiliki paragraf akhir atau ayat: "Ringkasan Kontribusi". Ini harus daftar kontribusi besar dalam bentuk peluru, menyebutkan dalam bagian mana mereka dapat ditemukan. Bahan ini berfungsi sebagai garis besar sisa kertas, menghemat ruang dan menghilangkan redundansi.

 

(Latihan:. Tuliskan daftar peluru untuk jenis contoh multiway)



 Kerja Terkait



The abadi Pertanyaan: Haruskah kerja terkait ditutupi dekat awal kertas atau dekat akhir?

• Awal,
  jika bisa pendek namun cukup rinci, atau jika hal itu penting untuk
  mengambil sikap defensif yang kuat tentang pekerjaan sebelumnya segera. Dalam hal ini Terkait Pekerjaan dapat berupa ayat pada akhir Pendahuluan, atau yang Bagian 2 sendiri. 


• End,
  jika dapat diringkas dengan cepat sejak awal (dalam Pengantar atau
  Pendahuluan), atau jika perbandingan yang cukup memerlukan isi teknis
  dari kertas.
  Dalam hal ini Terkait Pekerjaan harus muncul sebelum Kesimpulan,
  mungkin dalam bagian yang lebih umum "Diskusi dan Kerja Terkait".

Batang Tubuh  

Pedoman # 1:
Sebuah kontribusi teknis yang penting baru yang jelas seharusnya
diartikulasikan pada saat pembaca selesai halaman 3 (yaitu, seperempat
jalan melalui kertas). 

Pedoman # 2: Setiap bagian kertas harus bercerita.
(Jangan, bagaimanapun, jatuh ke dalam perangkap umum menceritakan
seluruh cerita tentang bagaimana Anda tiba di hasil Anda. Katakan saja
kisah hasil sendiri.) Cerita harus linier, menjaga pembaca terlibat di
setiap langkah dan mencari meneruskan ke langkah berikutnya. Seharusnya tidak ada gangguan yang signifikan - mereka bisa pergi dalam Lampiran, lihat di bawah.

Selain dari pedoman ini, yang berlaku untuk setiap kertas, struktur tubuh bervariasi banyak tergantung pada konten. Komponen penting adalah: 

• Menjalankan Contoh: Jika memungkinkan, gunakan contoh menjalankan seluruh kertas.
  Hal ini dapat diperkenalkan baik sebagai subbagian pada akhir
  Pendahuluan, atau Bagian sendiri 2 atau 3 (tergantung Terkait
  Pekerjaan). 


• Pendahuluan:
  Bagian ini, yang mengikuti Pengenalan dan mungkin Terkait Kerja dan /
  atau Menjalankan Contoh, set up notasi dan terminologi yang bukan
  merupakan bagian dari kontribusi teknis. Salah satu fungsi penting dari bagian ini adalah untuk menggambarkan materi yang tidak asli tapi diperlukan untuk kertas. Jadilah singkat - ingat Pedoman # 1. 


• Isi:
  Daging kertas termasuk algoritma, deskripsi sistem, konstruksi bahasa
  baru, analisis, dll Bila mungkin menggunakan "top-down" description:
  pembaca harus dapat melihat di mana materi yang terjadi, dan mereka
  harus mampu melompat ke depan dan masih mendapatkan ide.

Percobaan Kinerja    

Kita bisa memiliki seluruh risalah tentang topik ini sendirian dan saya pasti tidak ahli. Berikut adalah beberapa pemikiran acak:

• Banyak konferensi mengharapkan percobaan. 


• Sangat mudah untuk melakukan "tipu" atau percobaan berarti, dan banyak media dilakukan. 


• Sangat mudah untuk kerajinan percobaan untuk menunjukkan pekerjaan Anda dalam cahaya terbaik, dan paling kertas dilakukan. 


• Apa yang harus mengukur kinerja percobaan? Possiblities: 




• Waktu berjalan Murni 


• Sensitivitas terhadap parameter penting 


• Skalabilitas dalam berbagai aspek: ukuran data, kompleksitas permasalahan, ... 


• Lainnya?

• Apa yang harus percobaan menunjukkan kinerja? Kemungkinan: 




• Kinerja mutlak (yaitu, itu dapat diterima / digunakan) 


• Kinerja relatif terhadap pendekatan naif 


• Kinerja relatif terhadap pendekatan sebelumnya 


• Kinerja relatif antara pendekatan yang diusulkan berbeda 


• Lainnya?

Kesimpulan

Secara umum sebuah paragraf singkat meringkas akan lakukan, dan dalam
keadaan apapun harus paragraf ulangi bahan dari Abstrak atau
Pendahuluan.
Dalam beberapa kasus mungkin untuk sekarang membuat klaim asli lebih
konkret, misalnya, dengan mengacu pada hasil kinerja kuantitatif.



Kerja Masa Depan

Bahan ini penting - bagian dari nilai kertas menunjukkan bagaimana pekerjaan menetapkan arah penelitian baru. Saya suka daftar peluru sini. (Sebenarnya saya seperti mereka pada umumnya.) Beberapa hal yang perlu diingat:

• Jika Anda aktif terlibat dalam pekerjaan tindak lanjut, katakan demikian. Misalnya: "Kami sedang memperluas algoritma untuk ... bla bla, dan hasil awal yang menggembirakan." Pernyataan ini berfungsi untuk menandai wilayah Anda. 


• Sebaliknya, harus menyadari bahwa beberapa peneliti melihat ke bagian Pekerjaan Masa Depan untuk topik penelitian. Pendapat saya adalah bahwa tidak ada yang salah dengan itu - menganggap itu pujian.

Para Ucapan Terima Kasih

Jangan lupa mereka atau Anda akan memiliki orang-orang dengan perasaan terluka.
Akui siapa saja yang berkontribusi dengan cara apapun: melalui diskusi,
umpan balik pada konsep, implementasi, dll Jika ragu tentang apakah
akan menyertakan seseorang, termasuk mereka.



Kutipan

Luangkan upaya untuk membuat semua kutipan lengkap dan konsisten. Jangan hanya menyalin acak konsisten BibTeX (atau lainnya) entri dari web dan menyebutnya hari. Memeriksa bibliografi akhir Anda dengan hati-hati dan pastikan setiap entri terlihat benar.



Lampiran

Lampiran harus berisi bukti rinci dan algoritma saja. Lampiran dapat menjadi sangat penting untuk kertas overlength, tapi masih berguna sebaliknya. Pikirkan lampiran sebagai pembuktian acak-akses yang mendasari rincian berdarah. Sebagai aturan praktis:

• Lampiran tidak boleh mengandung bahan yang diperlukan untuk memahami kontribusi dari kertas. 


• Lampiran harus berisi semua materi yang sebagian besar pembaca tidak akan tertarik

Grammar dan Isu Presentasi Kecil

Secara umum semua orang menulis makalah sangat dianjurkan untuk membaca pendek dan sangat berguna The Elements of Style oleh Strunk dan Putih. Berikut adalah daftar acak Peeves hewan peliharaan.

• Sama seperti program, semua "variabel" (terminologi dan notasi) di
  koran harus didefinisikan sebelum digunakan, dan harus didefinisikan
  hanya sekali.
  (. Pengecualian: Kadang-kadang setelah hiatus panjang ini berguna untuk
  mengingatkan para pembaca definisi a) definisi global harus
  dikelompokkan ke bagian Pendahuluan, definisi lain harus diberikan
  sebelum digunakan pertama mereka. 


• Jangan gunakan "dll" kecuali item yang tersisa benar-benar jelas. 

• Diterima: Kami akan menomori tahap 1, 3, 5, 7, dll 


• Tidak dapat diterima: Kami mengukur faktor-faktor kinerja seperti volatilitas, skalabilitas, dll

(Latihan: Aturan di atas dilanggar setidaknya sekali dalam dokumen ini Temukan pelanggaran..)

• Jangan pernah berkata "karena berbagai alasan". (Contoh:. Kami memutuskan untuk tidak mempertimbangkan alternatif, karena berbagai alasan) Beritahu pembaca alasan!


• Hindari penggunaan sial dari "ini", "itu", "ini", "itu", dan seterusnya (Ullman pet mengesalkan). Membutuhkan identifikasi eksplisit dari apa yang "ini" mengacu pada menegakkan kejelasan tulisan. Berikut ini adalah contoh khas sial "ini": Percobaan kami menguji beberapa lingkungan yang berbeda dan algoritma tidak baik dalam beberapa tapi tidak semua dari mereka. Hal ini penting karena ... (Latihan: Aturan di atas dilanggar setidaknya sekali dalam dokumen ini Temukan pelanggaran..)


• Dicetak miring adalah untuk definisi atau kutipan, bukan untuk penekanan (Gries pet mengesalkan). Tulisan Anda harus dibangun konteks seperti itu saja memberikan penekanan yang memadai.
  
  (Latihan: Aturan di atas dilanggar setidaknya sekali dalam dokumen ini Temukan pelanggaran..)

• Algoritma yang mudah untuk melaksanakan semua berjalan dalam waktu linier. 


• Algoritma, yang mudah diterapkan, semua berjalan dalam waktu linier.

• Orang sering menggunakan "yang" versus "yang" salah. "Itu" adalah mendefinisikan, "yang" adalah nondefining. Contoh penggunaan yang benar:

  Mekanika

• Selalu menjalankan pemeriksa ejaan di atas kertas akhir Anda, tidak ada alasan. 


• Untuk draft dan laporan teknis menggunakan font yang 11 titik, murah
  hati spasi, 1 "margin, dan format kolom tunggal. Tidak perlu menyiksa
  pembaca kasual Anda dengan font kecil dan jarak ketat digunakan dalam
  proses konferensi hari ini. 


• Dalam draft dan font akhir kamera-siap, angka harus kira-kira ukuran
  font yang sama seperti yang digunakan untuk teks dalam tubuh kertas. 


• Tabel, gambar, grafik, dan algoritma harus selalu ditempatkan di bagian
  atas halaman atau kolom, bukan dalam tubuh teks kecuali itu sangat
  kecil dan cocok menjadi aliran kertas. 


• Setiap meja, angka, grafik, atau algoritma akan muncul pada halaman
  yang sama sebagai acuan pertama, atau pada halaman berikut (LaTeX
  bersedia ...). 


• Sebelum penyerahan akhir atau publikasi kertas Anda, mencetaknya
  sekali dan melihat - Anda mungkin akan cukup terkejut betapa berbedanya
  terlihat pada kertas dari bagaimana itu tampak pada layar Anda (jika
  Anda bahkan repot-repot untuk melihat setelah Anda berlari Lateks
  terakhir kali ...).

 

Versi dan Distribusi

• Banyak kertas memiliki (dan kemudian diterbitkan) versi konferensi
  disampaikan, bersama dengan "full paper" laporan teknis di web. Sangat penting untuk mengelola versi hati-hati, baik dalam isi dan proliferasi. Rekomendasi saya adalah, bila memungkinkan, untuk kertas penuh terdiri dari hanya versi konferensi ditambah lampiran.
  Makalah lengkap harus menjadi satu-satunya publik selain dari prosiding
  konferensi, itu harus dikoordinasikan dengan terbaru (final) versi
  konferensi, dan modifikasi kertas penuh harus selalu menimpa semua versi
  sebelumnya dapat diakses publik itu. 


• Saya percaya dalam menempatkan kertas di web begitu mereka selesai.
  Mereka harus diberi tanggal dan dapat dirujuk sebagai laporan teknis -
  itu tidak perlu untuk memiliki nomor laporan teknis yang sebenarnya.
  Jangan pernah memasang kertas dengan pemberitahuan hak cipta konferensi
  ketika itu hanya telah disampaikan, dan tidak pernah referensi makalah
  sebagai "disampaikan dalam konferensi X." Anda hanya meminta malu saat kertas akhirnya diterbitkan dalam konferensi Y satu atau dua tahun kemudian.