Bagaimana kami menulis artikel tentang Habr: pengalaman pengembang EastBanc Technologies

Baru-baru ini, dua artikel yang lalu, artikel ke seratus diterbitkan di pusat perusahaan kami. Untuk menghormati angka bulat, kami memutuskan untuk merangkum pengalaman kami sedikit. Dalam artikel ini, kami akan memberi tahu bagaimana pengembang kami mengerjakan artikel, yang membantu mereka menulis dan apa yang harus diperhatikan ketika mengerjakan teks.

Untuk memulai, jawab saja dua pertanyaan sederhana:

  • Mengapa saya membutuhkan ini?
  • Apa yang akan saya sampaikan menarik dan bermanfaat bagi komunitas habra?

Kemudian Anda dapat mengambil rencana dari artikel ini (atau membuat sendiri) dan melakukannya.

gambar

Ada tahapan kreatif dan teknis. Artikel ini tentang kreatif. Pertimbangkan:

  • Mengapa menulis artikel?
  • Di mana mendapatkan topik untuk artikel tersebut,
  • Di mana menemukan waktu untuk menulisnya,
  • Tahapan utama pekerjaan pada teks,
  • Apa yang harus dilakukan jika artikel tidak masuk,
  • Dan mulai dari mana jika Anda belum pernah menulis di Habr.

Kami berharap teks ini akan bermanfaat bagi penulis Habr lainnya, termasuk yang potensial.

Motivasi: mengapa saya, sebagai pengembang, menulis di Habr


Tidak ada jawaban tunggal dan tidak ada peluru perak. Oleh karena itu, kami memberikan jawaban karyawan kami, di mana setiap orang dapat mengenali diri mereka sendiri, dan kami akan mendengarkan dengan senang hati, seperti yang Anda miliki.

  • Sosialisasi
    Empati dan rasa komunitas memotivasi - Saya ingin berbagi emosi dan pemikiran tentang proses pengembangan dengan komunitas yang tertarik.
  • Atur pengetahuan Anda
    Saya suka urutan di kepala saya, dan menulis artikel atau teks akhir secara umum dapat mempercepat pencarian kesenjangan dalam pemahaman dan pengetahuan tentang topik tersebut. Artikel ini memungkinkan Anda untuk melihat topik dari sudut yang berbeda, untuk sepenuhnya mengetahui semua momen yang tidak dapat dipahami, untuk mewujudkan sesuatu.
  • Bunga memilah yang baru dan berbagi
    Dia termotivasi untuk menulis tentang sesuatu yang baru untuk dirinya sendiri, tentang apa yang segar di dunia pembangunan. Jika saya melakukan tugas-tugas tipikal, saya tidak berpikir akan ada semacam kelelahan dari ini. Secara umum, outputnya adalah instruksi dengan atau tanpa lelucon, yang menyerupai jawaban terinci dengan Stack Overflow pada pertanyaan / topik yang ditanyakan dalam judul artikel.
  • Hemat waktu untuk pelatihan di dalam
    Artikel ini adalah ringkasan untuk kolega yang masih harus menceritakannya nanti. Jadi dia menulis - dan mengirim atau mengadakan seminar.
  • Dapatkan umpan balik dan komentar perusahaan
    Cukup bagus untuk mendapatkan tampilan dan nilai tambah di set-off, ini meningkatkan karma. Peningkatan karma juga memotivasi Anda untuk menulis lebih jauh. Dalam komentar Anda dapat menemukan informasi yang berguna untuk diri sendiri dari orang-orang yang pergi dengan cara yang sama dan sudah mengisi benjolan.
  • Untuk yang terbaik
    Hal ini diilhami oleh keinginan untuk mempercepat perkembangan umat manusia - jika aktivitas penulis mana pun akan menghemat waktu lebih banyak daripada yang dihabiskannya - rata-rata, umat manusia cenderung mendapat manfaat dalam pembangunan, karena waktu yang dihemat mungkin akan dihabiskan untuk kegiatan yang bermanfaat.

Pilihan subjek mempertimbangkan utilitas untuk Habr


Saat memilih topik, kami fokus pada pengalaman subjektif kami dan kasus-kasus praktis, yang kami alami dan uji sendiri. Tentu saja, diasumsikan bahwa kita telah mempelajari literatur sebelumnya dan tidak akan mengulangi apa yang sudah ditulis. Dan menurut aturan bentuk yang baik, kami selalu merujuk ke sumber yang bermanfaat.

Topik bagus


  • Ada beberapa solusi yang dikatakan pengembang: "Tidak ada dokumentasi resmi tentang ini, di Habré juga. Saya harus mengotak-atik. " Jika keputusan itu sendiri layak, maka artikelnya akan bagus.
  • Beberapa topik berasal dari tantangan global yang ditimbulkan oleh proyek - misalnya, untuk menyediakan Ketersediaan Tinggi dan CI / CD transparan. Setiap langkah menuju sasaran ini - migrasi ke .Net Core, Docker, dan sebagainya - dapat dijelaskan dalam artikel terpisah. Di rapat umum, lelucon “menjadi artikel!” Sering kali dilewati, yaitu rekan seakan mengisyaratkan.
  • Bagian dari topik muncul ketika Anda secara aktif meneliti topik baru. Ada tanda: jika pengembang menghabiskan lebih dari 4 jam untuk meneliti Google atau membaca artikel lain, maka bermanfaat untuk setidaknya mengumpulkan informasi yang ditemukan, atau mungkin menulis sesuatu yang baru.
  • Beberapa teks lahir setelah membaca buku yang menarik, menghadiri konferensi yang baik atau bahkan sebagai dokumentasi internal - Saya ingin berbagi pengetahuan baru.

Apa yang bermanfaat itu baik, menghemat waktu di masa depan bagi pembaca dan memberikan pengalaman praktis, daripada spekulasi filosofis tentang perdamaian dunia.

Topik buruk


Ada banyak dari mereka, tetapi kami akan menyebutkan beberapa dari mereka:

  • Pengulangan semua yang diketahui untuk tujuan pengindeksan tunggal dengan kata kunci,
  • Iklan langsung atau tidak langsung dari perusahaan atau klien (lihat dengan siapa saya bekerja),
  • Artikel tentang apa-apa atau aliran pemikiran tanpa struktur.

Secara umum, semuanya buruk yang tidak menguntungkan pembaca atau tidak menghormatinya.

Tahapan utama pekerjaan pada teks


Bagi penulis, mengerjakan teks melewati 6 tahap kreatif:

  1. Penentuan tujuan: merumuskan tema, ide, dan rencana. Untuk menemukan topik, kami menjawab pertanyaan "Apa yang pembaca baru akan pelajari dari artikel ini", "Untuk siapa kami menulisnya", "Apa sebenarnya yang ingin kami bagikan". Penting juga bagi kita bahwa artikel tersebut membawa sesuatu yang baru. Untuk melakukan ini, kita melihat kata kunci yang telah ditulis pada topik ini dan apakah kita mengulangi diri kita sendiri.
  2. Catatan, atau jurnal laboratorium. Selama mengerjakan tugas, pengembang membuat catatan: menyimpan tautan yang bermanfaat, menulis jangkar pengingat untuk situasi darurat, sehingga Anda dapat membalikkan catatan insinyur menjadi teks yang dapat dibaca. Ketika datang ke teks, itu hanya tinggal membaca kembali "jurnal laboratorium", merumuskan kembali beberapa catatan menggunakan kosakata lebih atau kurang diterima secara umum, dan kemudian mengumpulkannya dalam urutan logis.
    Salah satu penulis kami menggunakan editor markdown online hackmd.io, di mana ia memperbaiki langkah-langkahnya dalam mengembangkan topik. Alat ini memungkinkan Anda untuk berbagi teks, menunjukkan kemajuan pada artikel, dan yang paling penting - untuk membuatnya terlebih dahulu. Sebagai hasilnya, kami mendapatkan teks untuk diterbitkan di Habr, cukup menambahkan potongan dan memberikan beberapa pukulan kecil. Ini nyaman untuk mengontrol struktur dan tata letak teks.
  3. Atur teksnya. Kami menulis pemikiran utama dan melihat kegunaannya dan menempatkannya dalam struktur artikel. Daftar isi diperoleh, yaitu pengelompokan teks menjadi blok semantik yang dapat dirasakan tanpa membaca bagian lain.
  4. Kami mengedit dan mengedit sehingga orang luar "yang tidak ada dalam subjek" dapat lebih atau kurang memahami arti dari apa yang dikatakan. Anda dapat membaca ulang setidaknya sekali sehari dan mengedit apa yang tidak Anda sukai. Pengeditan membutuhkan beberapa iterasi, seperti halnya pekerjaan pada teks. Pada tahap ini, kita melihat bahasa dan kesalahan - teks yang tidak diverifikasi dibaca seolah-olah ditulis oleh anak sekolah-dua.
  5. Kami melihat teks melalui mata orang lain : artikel sedang dibaca oleh pengembang lain atau PM yang kompeten dalam topik ini. Tampilan segar dan kritik membangun meningkatkan produk.
  6. Kami sedang mempersiapkan teks untuk dicetak. Kami melakukan pengeditan akhir, memikirkan ilustrasi, memilih hub yang sesuai - dan mencetak!

Urutan tahapan ini tidak ketat. Kebetulan penulis pertama membuat rencana, mengungkapkan setiap item dan merincinya ke tingkat yang diinginkan, kemudian mengoreksi teks dalam beberapa iterasi. Dan kebetulan bahwa pada awalnya pengembang menguraikan solusi untuk tugas pekerjaan, dan sudah atas dasar ini teks untuk Habr lahir. Pada tahap apa pun, kolega lain dapat bergabung dengan artikel untuk membantu dengan ide atau saran.

Dan sekarang dari rencana ke tindakan. Yaitu, untuk teks.

Banyak tugas: bagaimana menemukan waktu untuk mengerjakan teks


Bekerja pada teks dengan gaya "menunda semua tugas dan pergi dengan kepalanya" tidak berhasil karena faktor bus . Oleh karena itu, penulis secara bertahap terlibat dalam artikel di latar belakang sisa pekerjaan. Seringkali teks adalah ringkasan dari tugas kerja yang sebenarnya.

Salah satu penulis kami membandingkan karya ini dengan tes. Pada awalnya Anda berpikir bahwa tidak ada waktu untuk menulis tes. Kemudian Anda menanamkan kegiatan ini dalam proses - dan ternyata ada waktu. Teks, seperti tes, membantu dalam memahami apa yang terjadi. Bahkan jika Anda mengalokasikan ke artikel setiap jam sehari, itu akan berhasil. Tentu saja, jika itu penting bagi seseorang.

Lain menulis ketat di pagi hari. Hal pertama yang pertama. Mengetahui bahwa ia memiliki banyak pekerjaan utama di depan, ia dapat menghabiskan 20 menit pada teks dari awal hari kerja. Dalam keadaan seperti itu, ternyata menulis dengan jelas, ringkas dan dalam kasus ini.

Saya ingin menulis artikel tentang Habr dan bahkan muncul dengan topik. Di mana untuk memulai?


Tidak ada yang baru dalam masalah ini. Stephen King, George Orwell, Edgar Allan Poe, kawan Strugatsky, duet Henry Lyon Oldie, Richard Feynman dan banyak penulis lain dalam satu bentuk atau lainnya berkata:
"Jika Anda ingin memulai sesuatu (untuk menulis artikel, buku atau surat kepada teman), tetapi Anda masih tidak bisa melakukannya - tidak ada waktu dan situasi yang lebih baik untuk melakukan ini daripada ... sekarang!"

Salah satu dari kami membantu membuka editor teks dan menuangkan banyak pemikiran tentang topik di sana. Kemungkinan besar, maka ternyata ini adalah "semua salah," tetapi langkah pertama telah diambil - pekerjaan pada artikel telah dimulai.

Ada cara lain: mencari karyawan lain dan menceritakan kepadanya tentang topik artikel. Dan untuk memulai cerita dengan kata-kata: "Yah, singkatnya ...". Dan begitu pikiran pertama mengalir, berteriak, "Terima kasih!" lari ke dirimu dan segera tuliskan ceritamu. Dengan kata sederhana, dengan tikar produksi, yang kemudian Anda gantikan dengan sesuatu yang konstruktif.

Dan untuk camilan, jalan dari klasik sepenuhnya di bawah tanggung jawab Anda.

gambar

Saya sedang menulis, saya sedang menulis, saya mandek. Apa yang harus dilakukan


Ada tiga skenario yang dapat diterapkan pada situasi:

  • Nikmati secangkir teh dan bersantai. Anda tentu tidak perlu memaksakan diri ketika teks “tidak pergi” - tidak ada gunanya mengatasi hal tersebut. Ini, kebetulan, bukan hanya tentang menulis artikel.

    Tapi melempar pekerjaan tidak layak. Segera setelah Anda merasa lebih atau kurang rileks - baca kembali apa yang tertulis, pasti ada pikiran lain yang muncul di benak Anda. Gambar garis besar struktur teks. Lemparkan teks ke kolega.

    Lakukan sesuatu di sekitar teks, tetapi jangan memeras kata-kata. Kemudian pikiran-pikiran itu sendiri akan mulai berkerumun dan hanya perlu diambil oleh ekornya - dan menaruhnya di atas kertas / di editor teks.
  • Rake semua materi ke dalam rilis artikel semua "apa adanya". Pada titik ini, Anda harus selesai menulis pikiran utama atau secara logis menyimpulkan dengan kesimpulan yang ada. Jika ini terlihat bagus, maka sisanya dapat digeser ke artikel selanjutnya.
  • Pingsan yang dalam dan berkepanjangan bisa berarti bahwa topiknya tidak dekat, dan Anda tidak perlu menulis tentang itu. Topik-topik seperti itu lebih baik dipotong pada tahap pertama. Atau berkonsultasi dengan kolega.

Jika Anda memiliki pilihan lain, bagaimana keluar dari kebodohan kreatif - bagikan dalam komentar.

Kesimpulannya


Menulis Jangan dengarkan siapa pun dan tulis. Ini bagus. Dan Anda akan menulis dengan baik - umumnya bagus. Dan kemudian komunitas-habro akan tumbuh pintar, bersumpah dan menjadi kaya.

Akhirnya, tautan yang bermanfaat untuk topik ini:


Bagikan resep Anda di komentar, tunggu!

Source: https://habr.com/ru/post/id421613/


All Articles