WordPress Kullanarak Bir Yardım Yazma Aracı Nasıl Oluşturulur

İyi bir teknik yazar, güvenilir yardım yazma aracından (HAT) asla uzak değildir.

Teknik yazı ticaretinin beygir gücü - bir yardımcı yazma aracı, yükü alır ve 'karmaşık şeyleri sadeleştirme' sanatını dönüştürür… Pekala, çocuk oyuncağı.

HAT'ler, teknik yazarlar için üretkenliği maksimize eden unsurlardır. 10x teknik yazar, oyunlarının bu tarafını sağlam bir şekilde ayarlamıştır.

Amaca mükemmel bir şekilde uyum sağlamak için kopyayı biçimlendirme ve düzenlemenin yinelemeli birçok aşamasıyla…

…yanınızda çalışacak ve tüm çabalarınızı en iyi edebi ürünü formüle etmeye odaklamanıza yardımcı olacak bir HAT'a gerçekten ihtiyacınız var.

HAT kavramı yeni değil.

Etraftaydılar.

Bazıları, eğer bir aile fotoğrafı olsalardı, biraz sivri uçlu, sepyalaşmış ve hatta alaka düzeyinde solmuş olabileceklerini söyleyebilir.

Örneğin, çoğu durumda, bir WYSIWYG düzenleyicisine sahip olmak birinci sınıf bir özellik olarak kabul edilir.

Ancak daha yanal olarak düşünürsek, HAT'leri 21. yüzyıla fırlatmak için bir içerik yönetim sisteminin (CMS) çok yönlülüğünü ve çok yönlü aktarılabilir faydalarını uygulamak için bir durum var mı?

Dünyanın önde gelen web oluşturma platformu ve bir ülke çapında en popüler CMS yazılımı olan WordPress CMS örneğinde tartışırız…

…cevap Evet.

Ancak bunun için bizim sözümüze güvenmeyin, neden WordPress CMS'nin dilimlenmiş ekmek espresso kahvesinden bu yana teknik yazarlar için bir sonraki en iyi şey olduğunu biraz daha derinlemesine incelemek için birkaç dakikanızı ayırmayın.

İşte burada, WordPress kullanarak bir yardım yazma aracı oluşturmaya yönelik HeroThemes kılavuzu.

Günümüzün Teknik Yazarının Tipik Talepleri

Teknik yazı bugün birçok uzmanlık konusunu kapsamaktadır.

• Devlet kamu politikası
• BT bilgi işlem
• Finansal yatırım
• Emlak

…liste devam ediyor.

Ancak, teknik dünyaya karmaşıklığın tercümanları olmanın zorlu talepleri, günlük görevlerdir.

UK Government Digital Service'te Teknik Yazar, Servis Tasarımı ve Güvencesi olan Hızır Süleyman'a göre - aşağıdakiler onun düzenli günlük görevleridir:

• kullanıcı araştırmasına katılmak
• içerik stratejileri oluşturma
• planları kıdemli paydaşlara sunmak
• kullanıcı yolculuklarını tasarlama ve prototipleme
• içeriği tartışmak, düzenlemek ve (elbette) yazmak

Oldukça çeşitli.

Yine de, bu listedeki son fakat en az değil, (elbette) gerçekten yaptıklarını yapıyorlardı.

Ancak yazmak (ve özellikle teknik yazı) bir faaliyetten çok bir süreçtir.

Toplu olarak belgelerin teslimine yol açan görevlerin bayrak yarışı.

Özetle, teknik yazı “…hızla değişen yazılım sistemleri hakkında bilgi edinme, düzenleme ve sürdürme” süreci olarak tanımlanabilir – Atom Bank

Ve bu nedenle, teknik bir yazarın hayatındaki bir günün ortak özelliği, depoları ve bilgi tabanlarını yönetmektir.

Örneğin, uzman yorumlarının alıntılarını veya snippet'lerini kaydetmek. Ayrıca, argümanları doğrulamak için gerçek veya veri biçiminde altın külçeleri almak.

Kısacası, veri depolama, arama ve konum veya keşif kolaylığı - yazmanın yanı sıra - bir yardım yazma aracının önemli bir yardımcı işlevidir.

2022'de Yardım Yazma Aracı nedir?

Yardım yazma aracı için 1. sayfa Google tanımlarının çoğuna inanılacaksa, doğru bir açıklama şunları içermelidir:

1. Yapımı
2. yönetme
3. yayıncılık

…belgeler.

Çoğu, daha iyi bir kimliğin 'içerik yönetim sistemi' olacağını iddia ediyor.

Bu terimin CMS satıcıları tarafından yazılan makalelerde yer alma eğiliminde olduğu kabul edilir (ve bu bağlamda, bu makale farklı olmayacaktır), ancak doğruluk kullanımını incelersek – bir CMS sonuçta HAT için uygun bir etikettir.

Teknik yazarların yazar yardım belgelerine tam anlamıyla yardımcı olur.

Yardımla tam olarak ne demek istediğimizi tam olarak ortaya koymaya gelince - sanırım bunu ne kadar geniş bir şekilde alabileceğinize dair katı ve hızlı kurallar yok.

Gerçekten şunlara bağlı olacaktır:

1. Yazılım üreticilerinin teknik yazı disiplinini ne kadar derinden bildikleri ve;
2. İhtiyacı karşılamaya ne kadar ikna oldular?

Çoğu durumda HAT, taslak hazırlama ve editoryal temel bilgileri doğru almaya odaklanır.

Ve üstüne biraz şablonlama, stil oluşturma ve kodlama sunun.

Ama soru şu…

…bu işlevler tek başına günümüzün teknik yazarlarının zorlu taleplerini karşılamaya yeterli mi?

Neden birkaç tane sormuyoruz?…

1. Bu geri bildirim alıntısında, yanıtlayan (teknik bir yazar), geleneksel bir HAT işlevselliği ile geleneksel bir CMS'nin (Drupal) karşılaştırmalı bir incelemesini sunar:

“Drupal'da Yönetici olarak, sayfaların listesini görüntüleyebilirsiniz, ancak bir seferde yalnızca bir sayfanın özelliklerini düzenleyebilirsiniz. Çoklu seçim ve sürükle-bırak yok . Dolayısıyla konu yönetimi çok zahmetli olabilir.”

“Bir sayfayı silerseniz , ona işaret eden tüm bağlantılar bozulur ve sizi uyaracak hiçbir mesaj yoktur.

Bir sayfada bir bağlantı oluştururken , hedef sayfanın yolunu ve adını bilmeniz gerekir - mevcut sayfaların yararlı bir listesi yoktur."

“Kutunun dışında WYSIWYG editörü yok . HAT kullanıcılarının çoğu için bu bir zorunluluktur. İçeriğinizi yalnızca tam/filtrelenmiş html olarak yazabilirsiniz.”

(Kaynak: Kiraz Yaprağı)

2. Bu yorumda, başka bir kariyer teknik yazarı, HAT yazılımının geleceği için trend olacağını düşündüğü iki ideal işlevi tartıştı:

"Gerçek arama: bir kullanıcı arama sekmesini tıkladığında ve bir öğe aradığında, kullanıcı aşağıdaki resimde gösterildiği gibi benzer yönleri kullanarak arama sonuçlarını daraltabilir ."

"Standart yazma araçlarından herhangi birini kullanmak - Flare, RoboHelp, Author-It, Doc-to-Help - sizi tek bir kuruluştan tek bir noktadan çalışan tek bir yazarın bir okyanusu bir araya getirmeye çalıştığı gülünç modeliyle baş başa bırakıyor. bilgi. Bu model savunulamaz ve ölçeklenemez olduğundan, HAT'ler işbirlikçi web tabanlı yazma teknolojileri lehine kaybolacak .”

(Kaynak: Blog Yazmayı Tercih Ederim)

Yukarıda verilen bilgiler, teknik yazma üretkenliğini artırmak için daha dinamik ve işbirlikçi bir platform içerecek şekilde geleneksel HAT anlayışının kapsamını genişletiyor.

Yardım Yazarlığı için bir Bileşen İçerik Yönetim Sistemi (CCMS) kullanmayı düşünmeli misiniz?

Taneciklik hediye kontrolü.

Ve teknik yazı alanında, üretim döngüsü içinde daha fazla kontrolün avantajı, daha büyük proje ROI'sine dönüşen verimlilikleri doğurur.

Bu tam olarak bir bileşen içerik yönetim sisteminin devreye girdiği yerdir.

Bileşen içerik yönetim sistemi (CCMS) nedir?

Bileşen içerik yönetim sistemi, içerik öğeleri sayfalar ve gönderiler değil, pasajlar, paragraflar ve içerik bölümleri olan bir CMS'dir.

Aynı şekilde, bir CMS'de yeni bir içerik üretmeye geldiğinizde, yeni bir sayfa veya gönderi başlatırsınız.

Bir CCMS ile yeni bir bileşen başlatırsınız (bir sayfanın veya gönderinin bir bölümü).

Pek çok kısım bütün bir sayfayı oluşturur, bu nedenle bütün sayfaların ve gönderilerin nihai sonucu aynıdır, ancak bunların yapılış şekli küçük parçalara bölünmüştür.

Niye ya?

Ölçek ekonomileri.

Elbette, birden fazla parçaya (her birinin kendi meta verisine, bağımlılıklarına vb. sahip) dayalı sayfalar oluşturmak, tek bir serbest akışlı parça yerine tartışmasız daha fazla iş.

Ancak, çok sayıda güncel çapraz geçişli ve bileşen düzeyinde yeniden kullanılabilirliğe ve ayrıntılı değiştirilebilirliğe dahili referanslara sahip büyük ölçekli karmaşık içerik projeleri ile…

…bir CCMS, ekipler yazmak için uzun vadeli büyük avantaj sağlar.

Yani, işleri daha hızlı ve daha doğru bir şekilde yapmak.

Önerilen Yardım Yazma Aracı Tavsiye Makaleleri

En uygun yardım yazma aracını seçmek, yalnızca bir 'özellikler ve faydalar' karşılaştırmasından daha fazlasıdır.

En iyi sonucu elde etmek için kullanılabilirliği derinlemesine araştırmanız gerekir. İş akışlarını ve görev yönetimini anlamak, her bir çözümün sunduğu artıları ve eksileri görmenize yardımcı olacaktır.

Konuyla ilgili bazı meslektaşların tavsiye ettiği tavsiyelerde size yardımcı olmak için, HAT ile ilgili bu yararlı makalelerin bu hızlı listesini bir araya getirdik:

1. HAT'ler neden kaybolacak?
2. Bulut tabanlı bir geliştirme aracı kullanmanızı önermemin 5 nedeni
3. Bir HAT size Drupal üzerinden ne verir?
4. HAT yazılımını kullanmak için 6 neden
5. Teknik yazarların kullandığı 5 tür yazma aracı

Yukarıdaki makalelerin yazarları, HAT konusunda oldukça bilgili bir şekilde konuşurlar ve doğru kararı verme konusunda bir dizi içeriden ipucu verirler.

HAT'ın temel özellikleri nelerdir?

Bu nedenle, HAT'ler, ne yaptıkları ve geleneksel yaklaşımın yanı sıra göz önünde bulundurmamız gereken dış avantajlar konusundaki görüşümüzü yavaş yavaş pekiştiriyoruz.

Ancak yine de bir HAT deos'unun tüm şeyleri için kapsamlı bir referansa sahip olmamıza değer.

Bu şekilde, bir yatırım tercihini düşünürken 'elmayı elma' ile karşılaştırabiliriz.

En yaygın, en kapsamlı HAT yazılım işlevlerinin bir listesi:

• Çoklu giriş ve çıkış biçimleri : birçok dosya türünü kullanarak verileri içe ve dışa aktarın
• Tam özellikli kelime işlemci : hem kod tabanlı hem de görsel WYSIWYG düzenleyici
• Etiketler oluşturun : makaleleri tematik olarak ilişkilendirmek için topikal etiketler atayın
• Konu şablonları : önceden hazırlanmış şablonlarla her parçada bir adım önde başlayın  
• Sözdizimi vurgulayıcı : çözülmesi gereken dilbilgisi sorunlarıyla ilgili yararlı vurgular  
• Proje çapında meta bilgi için etiketleri birleştirme : birleştirme etiketlerini kullanarak kolaylıkla yeniden kullanılabilir snippet'ler ekleyin, zamandan tasarruf edin ve hatayı sınırlandırın
• Özel HTML, CSS, Javascript: özel web koduyla işlev ve tasarıma özel dokunuşlar uygulayın
• Proje içeriğini birleştir : harmanlanmış bir sonuç elde etmek için içeriği aynı proje içinde birleştirmek.  
• Özelleştirilebilir web teması : Kullanıcı deneyiminizi geliştirmek için aracın ön ucunu mükemmelleştirmek için anahtarlar, slaytlar ve onay kutuları
• Medya deposu : tüm resimleriniz, PDF'leriniz, ses ve video dosyalarınız için temiz bir depolama alanı  
• Kolay kullanıcı arayüzü : Ulaşılması kolay mesafe ve konumlandırmada ilgili tüm kontrollerle kullanımı basit  
• Çeviri : çoklu dil teslimi
• İçindekiler : İçeriği gözden geçirmek için her makalede kullanımı kolay atlama bağlantıları  

Dışarıdaki özel HAT'lar arasında - yukarıdaki noktalar, kaputun altında olması beklenenlerin çoğunu kapsıyor.

Özel bir HAT oluşturmanın faydaları

Özel bir HAT oluşturmanın önde gelen faydasını özetlemem gerekirse, şunu söylerdim:

Kendi araç setinizin ustalığı.

Özelleştirilmiş araç seti

Bir profesyonel olarak 'ne istediğinize', 'nerede ve nasıl istediğinize' sahip olduğunuzda, kazanılan zaman ve iyileştirilmiş sonuçlar açısından yatırım getirisi ölçülemez.

Başarı için 'tam doğru' olarak yapılmış araçları kullanma deneyimini, bir dizi genel 'yap-yap' aracıyla karşılaştıramazsınız.

Bu nedenle, kendi HAT'ınızı özelleştirmek, önemli ölçüde ön emek ve yaygara gerektirebilir.

Ancak uzun vadede, her projede kişisel olarak en iyinizi yenmeniz için sahne hazır.

Genişletilebilir

Özel bir HAT ile yol haritasındaki iyileştirmeleri beklemek veya premium yükseltmelere sıkışmak gerekmez.

Elbette, aletin servisinden ve geliştirilmesinden kendiniz sorumlu olacaksınız, ancak kısa bir DIY süresi için HAT'ınızın raf ömrünü uygun şekilde uzatabilirsiniz.

Kısacası, HAT'ınız iyileştikçe sonuçlarınız da iyileşecektir.

Her yönden daha iyi performans

Özel olarak oluşturulmuş bir HAT, teknik yazma iş akışınızdan tüm küçük veya engelleyici rahatsızlıkları kaldıracaktır.

Tüm darboğazları ve zaman kaybını ortadan kaldırarak, projelerinizi bir sonraki rüzgarda bitirme yarışına girmenizi sağlayan özellikler, seçenekler ve konfigürasyonlarla değiştirirsiniz.

Daha önce mümkün olduğunu düşündüğünüz şeyi kolayca pip edeceksiniz.

Heroic Knowledge Base Plugin ile bir WordPress Yardım Yazma Aracı Yapma

O halde, şimdiye kadar yeni sulara göğüs germeye ve kendi HAT'ınızı yapmaya hazırsanız, tam size göre bir çözümümüz var.

Kullanımı kolay.

Tüm çevrimiçi web sitelerinin %40'ından fazlasının kullandığı bir platform üzerine kurulmuştur.

En iyi özelliklerin tümü – artı daha fazlasıyla.

İşte… WordPress kullanarak kimin HAT yapacağına dair hızlı kılavuzumuz.

Ve en iyi yanı, hiçbir kod içermemesidir. Bu yöntem çok yeni başlayanlar için uygundur.

İşte sıra:

1. Sayfaların ve dosyaların düzenlenmesi ve sınıflandırılması
2. Arama, oylama, geri bildirim ve analiz
3. SSS bileşen çoğaltma
4. Biletler aracılığıyla sorguları işlemek için yardım masası
5. İçindekiler sayfa dizini
6. Sözlük terim kitaplığı

“Neden WordPress” üzerine kısa bir nokta.

Çoğu profesyonel için, iş için en iyi araçlara sahip olmak (adına bakılmaksızın) en önemli şeydir.

Semantik veya isim arama, çıktılara batmış hale geldiğiniz ve sizi kazmak için biraz torka sahip bir motora ihtiyaç duyduğunuz için çok fazla sayılmaz.

WordPress'in özel bir HAT yapmak için bir platform olarak ideal olduğu yer burasıdır.

İlk olarak, bu makalenin önceki bölümlerinde bahsedilen işlevler dizisindeki tüm gerekli kutuları işaretler. Ve bunu, temel teklifiyle kutudan çıkar çıkmaz kolaylıkla yapar.

WYSIWYG ve HTML, CSS ve JS kodlaması gibi özellikler, WordPress (dünyanın lider içerik yönetim sistemi) tarafından sunulan standart özelliklerdir.

Ancak WordPress ayrıca yarım trilyon dolarlık barındırma, eklenti ve tema ekonomisine de ev sahipliği yapıyor.

Bu oyuncular, aracı özel bir amaca uygun hale getiren 1. sınıf uzantıları ve performans yardımını sunmaktan sorumludur.

Sonuç olarak, WordPress ve eklenti yoldaşları, kendi kurulumlarını DIY yapmak isteyen herhangi bir teknik yazar için bir HAT'nin rüya ekibine sunulmasını sağlar.

WordPress kullanarak kendi çevrimiçi pazar yerinizi oluşturmak için önerilen adımlarımıza genel bir bakış:

Silo kategorileri içeren dizin ana sayfası: tamamlanan projeler ve araştırılan kaynaklar için referans kitaplığı dizini olarak hizmet veren bir merkez sayfası. Teknik yazı günlüğünüze erişmek için temiz, her şeyi içeren bir konum.

Daha önce yayınlanmış HAT içeriğinizin otomatik olarak bağlantılı ve ayrıntılı bir dizilimini oluşturmak için Heroic Knowledge Base eklentisini kullanın.

Arama, oylama, geri bildirim ve analiz: katkıda bulunan teknik yazarlarımızın işbirliği çağrısını makalenin önceki bölümlerinde dikkate alarak, dinamizmi ve etkileşimi WordPress HAT çözümümüzün özelliklerine entegre ettik. Arama, geri bildirim ve içgörü sağlamak yalnızca daha fazla iyileştirme geliştirmeye yardımcı olacaktır.

Ürün için yinelemeli bir iyileştirme yol haritasını yönlendirmek için kullanıcı araştırma geliştirmelerini etkinleştirmek için Heroic Knowledge Base eklentisini kullanın.

SSS bileşen çoğaltma : Daha büyük projeleri ölçeklendirmek için kendinize daha yalın bir üretime sahip olmanın avantajını vererek, sık sorulan sorularda ayrıntılı bileşen kontrolünü yapılandırın.

HAT'ınızı basit kurulum ve sero koduyla yerleşik yeniden kullanılabilir bileşenlerle donatmak için Kahramanca SSS eklentisini kullanın.

Talepler aracılığıyla sorguları işlemek için Kahramanca Gelen Kutusu: WordPress kurulumunuzun içinde yer alan duyarlı bir e-posta yardım kanalı sağlayan kullanıcı destek biletlerini uygun bir şekilde sahaya çıkarmak için.

İş e-posta gelen kutunuzu WordPress yönetici panonuza entegre etmek için Heroic Inbox eklentisini kullanın. Bu size HAT'ınız içinde birleşik bir iletişim merkezi sağlar, aksi takdirde ayrık bir iş akışında gezinmek için harcadığınız zamandan tasarruf edersiniz.

Kahramanca İçindekiler Tablosu: makalelerinizin eksiksiz okunmasını kolaylaştıran atlama bağlantıları, okuyucuların bilgileri sindirmesine ve değer elde etmesine yardımcı olur. Klasik bir ToC ile parçalarınızı daha da tüketilebilir hale getirin.

Makalelerinizin her birine otomatik olarak doldurulan bir içindekiler tablosu eklemek için Kahramanca İçindekiler Tablosunu kullanın.

Kahramanca Sözlük: Bir projedeki anahtar kelimelerin tanımlarına erişmenin bir kısayolu olarak kullanışlı terimlerin A'dan Z'ye bir listesini derleyin ve yeni projenizi yazarken çevik kalmanızı sağlayın.

WordPress HAT'ınıza aranabilir bir sözlük yüklemek için Heroic Glossary eklentisini kullanın - ter yok ve (yine) kod yok.

Aspose.Words: WordPress gönderilerini veya sayfalarını anında DOC veya DOCX dosyalarına veya tam tersine dönüştürün. İş akışı boşluklarını kapatın ve yeni sisteminizi eski GDocs veya Word dokümanları varlıklarıyla uyumlu hale getirin.

WordPress ve GDocs veya Word arasında çift yönlü dosya dönüştürmeyi etkinleştirmek için Aspose.Words eklentisini kullanın.

Syntax Highlighter Evolved: Özel düzenlemeler yaparken web kodunu öne çıkararak, dikkatiniz dağılmadan ayrıntılara odaklanmanıza yardımcı olur.

Web konusunda bilgili düzenlemelerinizi yaparken kodu güzelleştirmek için Sözdizimi Vurgulayıcı Evolved'i kullanın.

Çözüm

Bu tür gelişmiş CMS'lerin bu günlerinde amaca yönelik HAT'ler muhtemelen tekerleği yeniden icat ediyor.

Aslında, bazı yapılandırmalara sahip bir CMS'nin yapamayacağı, en gelişmiş özellikli HAT'ın bile yapabileceği pek bir şey yok (eğer varsa).

Ayrıca, bir CMS ile zaten rekabetçi bir teklife avantaj katan ek işlevselliğe sahip olursunuz.

Bir CMS (eklentileriyle pazar lideri WordPress) tarafından sağlanan daha fazla potansiyel, benzer bir HAT çözümünü beklentilerinizin ötesine taşıyabilir.

Kendi kaşıntılarınızı kaşımak ve WordPress ile yenilik yapmaya devam etmek için bolca alan - ayrıca kodlama gerekmez.

Hızla genişleyen bir 3. taraf eklenti ekosistemi, olasılık sınırlarını zorlamak için özel ürünlerle WordPress'in pazar payı avantajını destekler.

Sonuç olarak, geleceğe yönelik özel bir HAT yatırımı yapmak istiyorsanız WordPress CMS'nin ideal dijital platform olduğuna ikna olduk.

Neden bugün başlamıyorsun?