Kami saat ini menggunakan sistem yang disebut AsciiDoc yang memungkinkan kami membuat dokumentasi dalam markup teks sederhana. Dari sana kita dapat menghasilkan beberapa format output. Kami hanya menggunakan format pdf output dan output chm.
Saya bertanya-tanya apakah ada alternatif untuk chm? Apa yang saya cari adalah sesuatu yang dapat digunakan secara off-line (ini penting karena beberapa pengguna kami berada di tempat yang sangat terpencil) dengan perangkat lunak kami. Itu harus memiliki indeks (bisa sesederhana halaman html dengan istilah hyperlink), itu harus dapat dicari dan harus memiliki mekanisme yang memungkinkan entri tertentu dipanggil dari kode (mirip dengan bantuan konteks sensitif).
Dua hal yang bertentangan dengan PDF dalam hal ini adalah:
- Bantuan sensitif konteks bukan pilihan
- Umumnya dokumennya agak besar
- PDF lebih cocok untuk dokumentasi cetak daripada bantuan konteks sensitif
Yang saya inginkan adalah menggunakan html. Satu-satunya masalah dengan html adalah bahwa saya tidak bisa menemukan cara untuk secara otomatis menyediakan pencarian kata kunci (selain dari fungsionalitas ctrl + f browser - saya ingin sesuatu yang lebih jelas). Saya juga tidak bisa menemukan metode untuk secara otomatis menghasilkan indeks kata kunci yang hyperlink. Bantuan sensitif konteks akan sederhana karena tag bagian - Saya bisa dengan mudah melewatkan url halaman dan bagian yang saya minati ke browser default dan halaman itu harus memuat ke bagian yang benar.
Persyaratan saya terdengar sangat buruk seperti chm - benar. Saya memodelkan persyaratan saya dari chm. Satu-satunya alasan saya tidak suka chm adalah karena cara kode berinteraksi dengannya menggunakan mapid dan semacamnya. Saya lebih suka menggunakan menyimpan daftar teks biasa (yang secara otomatis dihasilkan untuk saya) yang dapat digunakan kode saya untuk mengakses bagian sensitif konteks dari dokumentasi.
Saya membayangkan skrip yang akan melalui file output html dan menghasilkan halaman indeks yang hanya berisi daftar kata kunci yang ditemukannya. jelas harus ada mekanisme pengecualian kata untuk mengabaikan kata-kata seperti: itu, itu, adalah, dll. Bagian ini akan relatif mudah untuk ditulis. Bagian kedua akan membutuhkan semacam skrip untuk mengumpulkan basis data kata kunci dan lokasinya dalam teks html. Saya pikir ini akan menjadi bagian yang sulit bersama dengan menyediakan mekanisme pencarian di dalam browser.
Setiap ide tentang alternatif akan dihargai. Saya ingin menggunakan wiki atau set halaman html statis yang dihosting di server web di suatu tempat, tetapi kami memiliki persyaratan penggunaan offline yang kritis. Cukup menempatkan html di drive lokal tidak memberi kami persyaratan pencarian yang kami butuhkan.
EDIT:
Saya merancang perangkat lunak yang digunakan oleh industri pertambangan. Banyak tambang sangat terpencil dan tidak memiliki akses ke internet dengan cara apa pun yang berarti. Tidak ada yang salah dengan pdf atau html atau chm (kecuali bahwa itu semakin tua). Jika saya bisa menampilkan file pdf di lokasi yang benar (yaitu bantuan konteks sensitif) saya akan menggunakannya. Saya hampir tergoda untuk menulis sendiri - pada dasarnya ini adalah wiki portabel. Omong-omong, jika Anda menyarankan wiki portabel - Anda harus memikirkan pengguna akhir yang mungkin tidak memiliki pengalaman dalam menggunakan alat tersebut. Itu harus mati sederhana. Itu adalah keindahan chm, itu menyakitkan untuk bekerja dengan tetapi pengguna akhir menyukainya.