Cara Membuat Alat Penulisan Bantuan Menggunakan WordPress

Seorang penulis teknis yang baik tidak pernah jauh dari alat bantu authoring (HAT) tepercaya mereka.

Pekerja keras dari perdagangan penulisan teknis – alat bantu penulisan, mengambil tekanan dan mengubah seni 'membuat hal-hal rumit menjadi sederhana'…yah, mudah.

HAT adalah pemaksimal produktivitas bagi penulis teknis. 10x penulis teknis memiliki sisi permainan mereka yang ditetapkan dengan kuat.

Dengan begitu banyak fase putaran berulang untuk membentuk dan mengedit salinan untuk membuatnya cocok untuk tujuan…

…Anda benar-benar membutuhkan HAT yang akan bekerja bersama Anda dan membantu Anda memfokuskan semua upaya Anda untuk merumuskan produk sastra terbaik.

Konsep HAT bukanlah hal baru.

Mereka sudah ada.

Dan beberapa orang mungkin mengatakan, jika itu adalah foto keluarga, mereka mungkin menjadi sedikit tertutup, sepia'd, dan bahkan memudar dalam relevansinya.

Misalnya, dalam banyak kasus, memiliki editor WYSIWYG dianggap sebagai fitur premium.

Tetapi berpikir lebih lateral, apakah ada kasus untuk menerapkan keserbagunaan dan manfaat multifaset yang dapat ditransfer dari sistem manajemen konten (CMS) untuk melontarkan HAT ke abad ke-21?

Kami berpendapat, dalam kasus WordPress CMS – platform pembuatan web terkemuka di dunia dan perangkat lunak CMS paling populer sejauh satu mil negara…

…jawabannya iya.

Tapi jangan hanya mengambil kata kami untuk itu, mengapa tidak mengambil beberapa menit berikutnya untuk menggali lebih dalam mengapa WordPress CMS adalah hal terbaik berikutnya yang terjadi untuk penulis teknis sejak irisan roti kopi espresso.

Ini dia, panduan HeroThemes untuk membangun alat bantu authoring menggunakan WordPress.

Tuntutan Khas Penulis Teknis Saat Ini

Penulisan teknis saat ini mencakup banyak mata pelajaran khusus.

• Kebijakan publik pemerintah
• komputasi TI
• Investasi keuangan
• Perumahan

... daftarnya terus berlanjut.

Tetapi yang umum adalah tuntutan ketat untuk menjadi penerjemah kompleksitas ke dunia teknis adalah tugas sehari-hari.

Menurut Khidr Suleman, Technical Writer, Service Design and Assurance di UK Government Digital Service – berikut adalah tugas rutinnya sehari-hari:

• berpartisipasi dalam riset pengguna
• membuat strategi konten
• mempresentasikan rencana kepada pemangku kepentingan senior
• merancang dan membuat prototipe perjalanan pengguna
• mendiskusikan, mengedit, dan (tentu saja) menulis konten

Cukup beragam.

Namun, last but not least dalam daftar itu adalah (tentu saja) melakukan apa yang benar-benar mereka lakukan.

Tetapi menulis (dan khususnya penulisan teknis) adalah sebuah proses daripada sebuah aktivitas.

Perlombaan tugas estafet yang secara kolektif mengarah pada pengiriman dokumentasi.

Singkatnya, penulisan teknis dapat digambarkan sebagai proses “…menangkap, mengatur, dan memelihara pengetahuan tentang sistem perangkat lunak yang berubah dengan cepat” – Atom Bank

Dan dengan demikian, fitur umum dalam kehidupan seorang penulis teknis adalah menangani repositori dan basis pengetahuan.

Merekam kutipan atau cuplikan komentar ahli, misalnya. Serta, mengambil nugget emas berupa fakta atau data untuk memvalidasi argumen.

Singkatnya, kemudahan penyimpanan data, pencarian dan lokasi atau penemuan – selain dari menulis – juga merupakan fungsi penting dari alat bantu authoring.

Apa itu Alat Penulisan Bantuan pada tahun 2022?

Jika mayoritas halaman 1 definisi Google untuk alat bantu penulisan dapat dipercaya, deskripsi yang akurat harus mencakup:

1. membuat
2. Mengelola
3. Penerbitan

… dokumen.

Sebagian besar mengklaim identitas yang lebih baik adalah 'sistem manajemen konten'.

Memang istilah ini cenderung dimasukkan dalam artikel yang ditulis oleh vendor CMS (dan dalam hal ini, artikel ini tidak akan berbeda), tetapi jika kita memeriksa penggunaan akurasi – CMS bagaimanapun adalah label yang sesuai untuk HAT.

Ini benar-benar membantu penulis teknis membantu dokumen.

Sejauh menunjukkan dengan tepat apa yang kami maksud dengan bantuan dengan tepat – saya kira tidak ada aturan yang keras dan cepat tentang seberapa luas Anda dapat mengambilnya.

Itu akan sangat tergantung pada:

1. Seberapa dalam produsen perangkat lunak mengetahui disiplin penulisan teknis, dan;
2. Betapa terbujuknya mereka untuk memenuhi kebutuhan

Dalam kebanyakan kasus, HAT fokus untuk mendapatkan dasar-dasar penyusunan dan editorial yang benar.

Dan tawarkan sedikit, templating, gaya dan pengkodean di atas.

Tapi pertanyaannya adalah…

…apakah fungsi-fungsi ini saja cukup untuk memenuhi tuntutan curam dari penulis teknis modern?

Mengapa kita tidak bertanya beberapa saja?…

1. Dalam kutipan umpan balik ini, responden (penulis teknis) memberikan tinjauan komparatif tentang fungsionalitas HAT tradisional vs. CMS tradisional (Drupal):

“Sebagai Administrator di Drupal, Anda dapat melihat daftar halaman, tetapi Anda hanya dapat mengedit properti dari satu halaman dalam satu waktu. Tidak ada pilihan ganda dan tidak ada drag-and-dropping . Jadi manajemen topik bisa sangat melelahkan.”

“Jika Anda menghapus halaman, maka semua tautan yang mengarah ke sana akan rusak , dan tidak ada pesan untuk memperingatkan Anda.

Saat membuat tautan di halaman, Anda harus mengetahui jalur dan nama halaman tujuan – tidak ada daftar halaman yang tersedia yang berguna.”

“Di luar kotak tidak ada editor WYSIWYG . Bagi sebagian besar pengguna HAT, ini adalah suatu keharusan. Anda hanya dapat menulis konten Anda dalam html lengkap/terfilter.”

(Sumber: Daun Ceri)

2. Dalam komentar ini, penulis teknis karir lainnya membahas dua fungsi ideal yang menurutnya akan menjadi tren untuk masa depan perangkat lunak HAT:

Pencarian fakta: ketika pengguna mengklik tab pencarian dan mencari item, pengguna dapat mempersempit hasil pencarian dengan menggunakan aspek serupa, seperti yang ditunjukkan pada gambar berikut.

“Menggunakan salah satu alat pembuat standar — Flare, RoboHelp, Author-It, Doc-to-Help — memberi Anda model konyol dari seorang penulis tunggal yang bekerja dari satu sudut pandang dari satu organisasi yang mencoba menyatukan lautan informasi. Karena model itu tidak dapat dipertahankan dan tidak dapat diskalakan, HAT akan memudar demi teknologi penulisan berbasis web kolaboratif .”

(Sumber: Saya Lebih Suka Menulis Blog)

Wawasan yang diberikan di atas memperluas jangkauan pengertian tradisional HAT untuk memasukkan platform yang lebih dinamis dan kolaboratif untuk meningkatkan produktivitas penulisan teknis.

Haruskah Anda mempertimbangkan untuk menggunakan Sistem Manajemen Konten Komponen (CCMS) untuk Penulisan Bantuan?

Kontrol hadiah granularitas.

Dan di bidang penulisan teknis, keuntungan dari kontrol yang lebih besar dalam siklus produksi menghasilkan efisiensi yang diterjemahkan ke dalam ROI proyek yang lebih besar.

Di sinilah sistem manajemen konten komponen masuk.

Apa itu sistem manajemen konten komponen (CCMS)?

Sistem manajemen konten komponen adalah CMS yang item kontennya bukan halaman dan postingan, melainkan cuplikan, paragraf, dan bagian konten.

Begitu banyak cara yang sama ketika Anda datang untuk menghasilkan konten baru di CMS, Anda akan memulai halaman atau posting baru.

Dengan CCMS, Anda akan memulai komponen baru (bagian dari halaman atau posting).

Banyak porsi menjadi satu halaman utuh, jadi hasil akhir keseluruhan halaman dan postingan sama, tetapi cara pembuatannya dipecah menjadi potongan-potongan kecil.

Mengapa?

Skala ekonomi.

Tentu ini bisa dibilang lebih banyak pekerjaan untuk membangun halaman berdasarkan beberapa bagian (masing-masing dengan metadata mereka sendiri, dependensi, dll.) daripada satu bagian utuh yang mengalir bebas.

Namun, dengan proyek konten kompleks berskala besar dengan banyak persilangan topikal dan referensi internal, dapat digunakan kembali dan dipertukarkan granular pada tingkat komponen…

… sebuah CCMS menawarkan keuntungan jangka panjang yang besar untuk menulis tim.

Yaitu, menyelesaikan sesuatu lebih cepat dan lebih akurat.

Artikel Saran Alat Penulisan Bantuan yang Disarankan

Memilih alat pembuat bantuan yang paling sesuai lebih dari sekadar perbandingan 'fitur dan manfaat'.

Untuk mendapatkan hasil terbaik, Anda harus mempelajari kegunaannya secara mendalam. Memahami alur kerja dan manajemen tugas akan membantu Anda melihat pro dan kontra yang disajikan oleh setiap solusi.

Untuk membantu Anda dalam beberapa saran yang direkomendasikan rekan tentang topik tersebut, kami telah mengumpulkan daftar singkat artikel terkait HAT yang berguna ini:

1. Mengapa HAT akan memudar
2. 5 alasan mengapa saya merekomendasikan penggunaan alat pembuat berbasis cloud
3. Apa yang diberikan HAT kepada Anda daripada Drupal?
4. 6 alasan untuk menggunakan perangkat lunak HAT
5. 5 jenis alat penulisan yang digunakan penulis teknis

Para penulis artikel di atas berbicara cukup berpengetahuan tentang masalah HAT dan memberikan sejumlah tips jalur dalam membuat keputusan yang tepat.

Apa saja fitur utama HAT?

Jadi, kami secara bertahap memperkuat pandangan kami tentang HAT, apa yang mereka lakukan dan keuntungan luar yang harus kami pertimbangkan selain pendekatan tradisional.

Tapi itu masih layak kita memiliki referensi yang komprehensif untuk semua hal yang HAT deos.

Dengan cara ini kita dapat membandingkan 'apel untuk apel' ketika mempertimbangkan pilihan investasi.

Berikut adalah daftar fungsi perangkat lunak HAT yang paling umum dan paling inklusif:

• Beberapa format input dan output : impor dan ekspor data menggunakan banyak jenis file
• Pengolah kata berfitur lengkap : editor WYSIWYG berbasis kode dan visual
• Buat tag : tetapkan tag topikal untuk menghubungkan artikel secara tematis
• Template topik : dapatkan permulaan di setiap bagian dengan template yang sudah jadi  
• Penyorot sintaks : sorotan yang membantu tentang masalah tata bahasa untuk diselesaikan  
• Gabungkan tag untuk info meta seluruh proyek : masukkan cuplikan yang dapat digunakan kembali dengan mudah menggunakan tag gabungan, menghemat waktu, dan membatasi kesalahan
• HTML, CSS, Javascript khusus: terapkan sentuhan khusus pada fungsi dan desain dengan kode web khusus
• Gabungkan konten proyek : menggabungkan konten dalam proyek yang sama untuk menghasilkan hasil campuran.  
• Tema web yang dapat disesuaikan : sakelar, slide, dan kotak centang untuk menyempurnakan tampilan depan alat guna meningkatkan pengalaman pengguna Anda
• Repositori media : area penyimpanan yang rapi untuk semua file gambar, PDF, audio, dan video Anda  
• Antarmuka pengguna yang mudah : mudah digunakan dengan semua kontrol yang relevan dalam jarak dan posisi yang mudah dijangkau  
• Terjemahan : pengiriman berbagai bahasa
• Daftar isi : tautan lompat yang mudah digunakan di setiap artikel untuk membaca sekilas konten  

Di antara HAT khusus di luar sana – poin di atas mencakup sebagian besar dari apa yang diharapkan di bawah tenda.

Manfaat membangun HAT khusus

Jika saya harus merangkum manfaat utama membangun HAT khusus, saya akan mengatakan:

Penguasaan toolset Anda sendiri.

Perangkat yang disesuaikan

Ketika Anda memiliki 'apa yang Anda inginkan', 'di mana dan bagaimana Anda menginginkannya' sebagai seorang profesional, pengembalian investasi dalam waktu yang dihemat dan hasil yang ditingkatkan tidak dapat diukur.

Anda tidak bisa membandingkan pengalaman menggunakan alat yang dibuat 'tepat' untuk sukses vs. seperangkat instrumen 'make do' generik.

Jadi, menyesuaikan HAT Anda sendiri mungkin memerlukan banyak tenaga dan kerepotan di muka.

Tetapi dalam jangka panjang, situasinya ditentukan untuk Anda mengalahkan yang terbaik secara pribadi Anda dengan setiap proyek.

Dapat diperluas

Menunggu perbaikan yang dipetakan, atau diperas ke peningkatan premium tidak perlu terjadi dengan HAT khusus.

Tentu, Anda akan bertanggung jawab untuk memperbaiki dan memperbaiki alat itu sendiri, tetapi hanya dengan sedikit waktu DIY, Anda dapat memperpanjang masa simpan HAT Anda dengan tepat.

Singkatnya, saat HAT Anda menjadi lebih baik, demikian juga hasil Anda.

Performa keseluruhan yang lebih baik

HAT yang dibuat khusus akan menghilangkan semua gangguan kecil atau mengganggu dari alur kerja penulisan teknis Anda.

Anda menghilangkan semua hambatan dan pengurasan waktu, menggantinya dengan fitur, opsi, dan konfigurasi yang membuat balapan Anda lebih cepat untuk menyelesaikan proyek.

Anda akan dengan mudah pip apa yang Anda pikir sebelumnya mungkin.

Membuat Alat Penulisan Bantuan WordPress dengan Plugin Basis Pengetahuan Heroic

Jadi, sekarang jika Anda siap menghadapi tantangan baru dan terjun membuat HAT Anda sendiri – kami punya solusi untuk Anda.

Mudah digunakan.

Dibangun di atas platform yang digunakan oleh lebih dari 40% dari semua situs web online.

Dengan semua fitur terbaik – plus lebih banyak lagi.

Ini dia… panduan singkat kami tentang siapa yang membuat HAT menggunakan WordPress.

Dan bagian terbaiknya adalah tidak ada kode yang terlibat sama sekali. Metode ini sangat ramah pemula.

Berikut line upnya:

1. Mengatur dan mengkategorikan halaman dan file
2. Pencarian, pemungutan suara, umpan balik, dan analitik
3. Replikasi komponen FAQ
4. Helpdesk untuk menangani pertanyaan melalui tiket
5. Indeks halaman Daftar Isi
6. Pustaka istilah glosarium

Poin singkat tentang "mengapa WordPress".

Bagi sebagian besar profesional, memiliki alat terbaik untuk pekerjaan itu (terlepas dari apa namanya) adalah hal yang paling penting.

Semantik atau panggilan nama tidak berarti banyak karena Anda menjadi tenggelam dalam kiriman dan membutuhkan mesin dengan beberapa torsi untuk menggali Anda.

Di sinilah WordPress ideal sebagai platform untuk membuat HAT kustom.

Pertama, ini mencentang semua kotak penting dalam jajaran fungsi yang disebutkan sebelumnya dalam artikel ini. Dan ia melakukannya dengan mudah, langsung dari kotak dengan penawaran intinya.

Fitur seperti WYSIWYG dan HTML, CSS dan JS coding adalah fitur standar yang ditawarkan oleh WordPress (sistem manajemen konten terkemuka di dunia).

Tetapi WordPress juga menampung setengah triliun dolar hosting, plugin, dan ekonomi tema.

Para pemain ini bertanggung jawab untuk memberikan ekstensi kelas 1 dan bantuan kinerja yang membuat alat ini sesuai untuk tujuan tertentu.

Secara keseluruhan, WordPress dan pendamping pluginnya membuat tim impian menawarkan HAT untuk setiap penulis teknis yang ingin membuat pengaturan mereka sendiri.

Berikut adalah ikhtisar langkah-langkah yang kami rekomendasikan untuk membangun pasar online Anda sendiri menggunakan WordPress:

Halaman beranda direktori dengan kategori tertutup: halaman hub yang berfungsi sebagai indeks perpustakaan referensi Anda untuk proyek yang telah diselesaikan dan sumber daya yang diteliti. Lokasi catch-all yang rapi untuk mengakses log penulisan teknis Anda.

Gunakan plugin Pangkalan Pengetahuan Heroik untuk menghasilkan daftar konten HAT yang ditautkan & diperinci secara otomatis dari konten HAT Anda yang diterbitkan sebelumnya.

Pencarian, pemungutan suara, umpan balik & analitik: memperhatikan panggilan untuk kolaborasi dari penulis teknis yang berkontribusi dari sebelumnya dalam artikel, kami telah mengintegrasikan dinamisme dan keterlibatan dalam fitur solusi HAT WordPress kami. Menyediakan penelusuran, umpan balik, dan wawasan hanya akan membantu mengembangkan peningkatan yang lebih besar.

Gunakan plugin Heroic Knowledge Base untuk mengaktifkan peningkatan penelitian pengguna untuk mengarahkan peta jalan peningkatan berulang untuk produk.

Replikasi komponen FAQ : mengonfigurasi kontrol komponen granular pada pertanyaan umum, memberi Anda keuntungan memiliki produksi yang lebih ramping untuk menskalakan proyek yang lebih besar.

Gunakan plugin Heroic FAQs untuk melengkapi HAT Anda dengan komponen bawaan yang dapat digunakan kembali dengan pemasangan sederhana dan kode sero.

Kotak Masuk Heroik untuk menangani pertanyaan melalui tiket: untuk dengan mudah mengirimkan tiket dukungan pengguna yang memberi Anda saluran bantuan email responsif yang ada di dalam instalasi WordPress Anda.

Gunakan plugin Heroic Inbox untuk mengintegrasikan kotak masuk email bisnis Anda ke dasbor admin WordPress Anda. Ini memberi Anda hub komunikasi terpadu dalam HAT Anda sehingga menghemat waktu yang hilang jika tidak dihabiskan untuk menavigasi alur kerja yang terputus-putus.

Daftar Isi Heroik: tautan lompat untuk memfasilitasi pembacaan sepintas artikel Anda membantu pembaca mencerna info dan mengekstrak nilai. Jadikan karya Anda lebih dapat dikonsumsi dengan ToC klasik.

Gunakan Daftar Isi Heroik untuk menambahkan daftar isi yang terisi otomatis ke setiap artikel Anda.

Heroic Glosarium: kompilasi daftar AZ istilah yang berguna sebagai jalan pintas untuk mengakses definisi kata kunci pada sebuah proyek, membuat Anda tetap gesit saat menulis proyek baru Anda.

Gunakan plugin Heroic Glossary untuk menginstal glosarium yang dapat dicari ke dalam HAT WordPress Anda – tanpa keringat, dan (sekali lagi) tanpa kode.

Aspose.Words: langsung mengonversi posting atau halaman WordPress menjadi file DOC atau DOCX dan sebaliknya. Jembatani kesenjangan alur kerja dan buat sistem baru Anda kompatibel dengan aset GDocs lama atau dokumen Word.

Gunakan plugin Aspose.Words untuk mengaktifkan konversi file dua arah antara WordPress dan GDocs atau Word.

Syntax Highlighter Evolved: buat kode web menonjol saat Anda melakukan pengeditan khusus, membantu Anda fokus pada detail tanpa gangguan.

Gunakan Syntax Highlighter Evolved untuk membuat kode menjadi indah saat Anda mengedit web dengan cerdas.

Kesimpulan

HAT yang dibuat khusus pada hari-hari ini dengan CMS canggih seperti itu mungkin menciptakan kembali roda.

Sebenarnya tidak banyak (jika ada) yang bahkan HAT berfitur paling canggih pun dapat melakukannya yang tidak dapat dilakukan oleh CMS dengan beberapa konfigurasi.

Plus, dengan CMS, Anda memiliki fungsionalitas tambahan yang menambah keuntungan pada penawaran yang sudah kompetitif.

Potensi lebih lanjut yang diberikan oleh CMS (WordPress terkemuka di pasar dengan pluginnya) dapat memperluas solusi HAT suka-untuk-suka melampaui apa yang Anda harapkan.

Banyak ruang untuk menggaruk gatal Anda sendiri dan terus berinovasi dengan WordPress – ditambah tidak perlu coding.

Ekosistem plugin pihak ketiga yang berkembang pesat mendukung keunggulan pangsa pasar WordPress dengan produk khusus untuk mendorong batas kemungkinan.

Secara keseluruhan, kami yakin bahwa jika Anda ingin membuat investasi HAT kustom bukti masa depan, WordPress CMS adalah platform digital yang ideal.

Mengapa tidak mulai hari ini?