Help & Manual: Kapsamlı Yardım ve Teknik Belgeleme Yazılımı

Help & Manual, EC Software tarafından geliştirilen, teknik yazarlar, yazılım geliştiriciler ve dokümantasyon uzmanları için tasarlanmış kapsamlı bir yardım dosyası ve teknik belgeleme aracıdır. Temel amacı, tek bir kaynaktan (Single-Source Publishing) farklı formatlarda (HTML Help, WebHelp, PDF kılavuzları, e-kitaplar, Word belgeleri, ePub, Kindle ve daha fazlası) yüksek kaliteli teknik belgeler, kullanım kılavuzları, yardım dosyaları ve eğitim materyalleri oluşturmayı ve yönetmeyi kolaylaştırmaktır.

Word işlemci benzeri bir kullanıcı arayüzü sunarak teknik belgeleme sürecini basitleştirir, aynı zamanda karmaşık projeleri yönetmek için güçlü özellikler sunar.

Ne İşe Yarar?

Help & Manual, bir dizi teknik belgeleme ve bilgi yönetimi ihtiyacını karşılar:

• Yardım Dosyaları Oluşturma: Windows uygulamaları için standart HTML Help (CHM), Microsoft Help 2.0 (MS Help 2) ve Microsoft Help Viewer formatlarında yardım dosyaları oluşturma.
• Web Tabanlı Yardım Sistemleri (WebHelp): Çevrimiçi kullanım için modern, duyarlı ve arama özellikli WebHelp sistemleri (HTML5 tabanlı) oluşturma. Bu, web sitelerinde, intranetlerde veya mobil cihazlarda görüntülenebilen çevrimiçi yardım merkezleri oluşturmak için idealdir.
• PDF Kılavuzları ve Baskılı Belgeler: Profesyonel görünümlü PDF kılavuzları, kullanım el kitapları ve baskıya hazır dokümanlar oluşturma. Otomatik içindekiler tablosu, indeks ve sayfa numaralandırma gibi özellikler sunar.
• e-Kitap ve Mobil Formatlar: ePub ve Kindle (Mobi) formatlarında e-kitaplar ve mobil cihazlar için optimize edilmiş belgeler hazırlama.
• Microsoft Word ve Diğer Ofis Formatları: Belge içeriğini Microsoft Word formatına (.docx) veya diğer RTF/TXT formatlarına aktarma.
• Tek Kaynak Yayıncılık (Single-Source Publishing): Tüm içeriği tek bir ana projede yöneterek, bu projeden farklı çıktı formatları oluşturmayı sağlar. Bu, içeriği her format için ayrı ayrı düzenleme ihtiyacını ortadan kaldırır ve tutarlılığı sağlar.
• Konu Tabanlı Yazma: Belgeyi küçük, yönetilebilir konulara (topics) ayırarak, bu konuları yeniden kullanma ve farklı belgelerde bağlama imkanı sunar.
• Resim ve Multimedya Yönetimi: Ekran görüntüleri, resimler ve multimedya öğelerini kolayca ekleme, düzenleme ve yönetme. Dahili ekran görüntüsü aracı ve resim düzenleyiciye sahiptir.
• Değişkenler (Variables) ve Koşullu Metin (Conditional Text): İçeriği farklı hedef kitleler veya ürün versiyonları için kolayca özelleştirmek için değişkenler ve koşullu metin kullanma. Örneğin, aynı metni farklı ürün adlarıyla yayınlamak veya yalnızca belirli bir versiyonda görünen bölümler oluşturmak.
• Versiyon Kontrolü Entegrasyonu: Git, SVN gibi popüler versiyon kontrol sistemleriyle entegrasyon desteği.
• Ekip İşbirliği: Çoklu yazar desteği ve projeleri yönetme yetenekleri ile büyük ekiplerin işbirliği içinde çalışmasını kolaylaştırır.
• Dahili Çeviri Desteği: Belge içeriğini çeviri için XLIFF formatına dışa aktarma ve çevrilmiş içeriği tekrar içe aktarma yeteneği ile çok dilli belgeleme süreçlerini kolaylaştırır.

Temel Özellikleri

Help & Manual’ın öne çıkan temel özellikleri şunlardır:

• Tek Kaynak Yayıncılık: En güçlü özelliğidir. Tek bir proje dosyasından birçok farklı formatta çıktı üretebilme.
• WYSIWYG (Ne Görüyorsan Onu Alırsın) Editör: Microsoft Word benzeri bir düzenleyici ile metinleri, resimleri ve diğer öğeleri kolayca biçimlendirme. HTML, CSS veya XML bilgisi gerektirmez.
• Geniş Çıktı Formatı Desteği: CHM, WebHelp (HTML5), PDF, Word (DOCX), ePub, Mobi, TXT, XML ve daha fazlası.
• Koşullu Metin ve Değişkenler: Farklı ürün versiyonları, diller veya hedef kitleler için içeriği özelleştirme esnekliği.
• Dahili Resim Düzenleyici ve Ekran Görüntüsü Aracı: Resimleri doğrudan program içinde yakalama ve düzenleme yeteneği.
• Gelişmiş Dizin ve Arama Özellikleri: Yardım dosyalarında ve WebHelp çıktılarında kapsamlı bir dizin ve güçlü arama işlevleri oluşturma.
• Proje Yönetimi ve İşbirliği: Büyük belgeleme projelerini yönetmek için yapılandırma, versiyon kontrol entegrasyonu ve çoklu yazar desteği.
• Video ve Multimedya Desteği: Belgelere video ve ses dosyalarını kolayca gömme.
• Şablonlar ve Stillendirme: Profesyonel görünümlü belgeler oluşturmak için özelleştirilebilir şablonlar ve stil sayfaları (CSS).
• Tümleşik Çeviri İş Akışı: Çok dilli projeler için çeviri yönetimini kolaylaştıran XLIFF entegrasyonu.

Nasıl Çalışır?

Help & Manual, belge oluşturma ve yayınlama sürecini merkezileştirir:

1. Yeni Proje Oluşturma: Kullanıcı, yeni bir Help & Manual projesi başlatır. Bu proje, tüm konuları, resimleri, değişkenleri ve çıktı ayarlarını içeren tek bir dosya olur.
2. Konuları Yazma: Belge, hiyerarşik bir yapı içinde “konulara” (topics) ayrılır. Her konu, bir Word belgesindeki bir bölüm gibi düşünebilir. Kullanıcı, WYSIWYG düzenleyiciyi kullanarak metinleri yazar, resimler ekler, tablolar oluşturur ve biçimlendirmeyi yapar.
3. Resim ve Multimedya Ekleme: Gerekli ekran görüntüleri dahili araçla alınır veya mevcut resimler içe aktarılır. Videolar veya ses dosyaları konulara gömülür.
4. Değişkenler ve Koşullu Metin Kullanımı: Eğer aynı metnin farklı versiyonlarda veya hedef kitlelerde değişmesi gerekiyorsa, değişkenler tanımlanır veya koşullu metin blokları oluşturulur.
5. Çıktı Ayarlarını Yapılandırma: Kullanıcı, projesinden hangi formatlarda çıktı alacağını (örneğin WebHelp, PDF, CHM) seçer ve her format için özel ayarları (şablonlar, stiller, hedef klasörler) yapılandırır.
6. Yayına Alma (Publishing): Tek bir “Yayınla” butonuyla, Help & Manual, tüm proje içeriğini seçilen formatlara dönüştürür ve gerekli tüm dosyaları (HTML dosyaları, resimler, CSS, JavaScript dosyaları) oluşturur.
7. Yayınlama Sonrası: Oluşturulan çıktı dosyaları ilgili yerlere (web sunucusu, uygulama dizini, baskı merkezi) dağıtılır.

Genel olarak, Help & Manual, profesyonel kalitede teknik belgeler, yardım dosyaları ve kullanım kılavuzları oluşturmak isteyen her büyüklükteki şirket veya bireysel teknik yazarlar için oldukça güçlü ve verimli bir çözümdür. Tek kaynak yayıncılığın sağladığı zaman tasarrufu ve tutarlılık, yatırım maliyetini karşılayabilir, özellikle de sık sık farklı formatlarda belge yayınlaması gerekenler için.