DevDocs: Platform dokumentasi untuk mencari berbagai dokumentasi teknologi di satu tempat

 (devdocs.io)
3 poin oleh GN⁺ 2024-01-14 | 1 komentar | Bagikan ke WhatsApp
  • Mengumpulkan dokumentasi API yang sering dicari developer di satu tempat agar bisa dicari dengan cepat, sehingga mengurangi biaya berpindah antar dokumentasi untuk tiap bahasa dan framework
  • Secara default menampilkan CSS, HTML, HTTP, JavaScript, dan Web APIs; di Preferences Anda bisa mengaktifkan lebih banyak dokumentasi yang diperlukan dan menyesuaikan tampilan
  • Memungkinkan akses lebih cepat ke item yang diinginkan melalui fuzzy matching seperti mencari background-clip dengan bgcp, serta pembatasan cakupan pencarian per dokumentasi
  • Mendukung shortcut keyboard untuk penggunaan tanpa mouse, pencarian dari address bar browser, penggunaan di mobile, dan instalasi sebagai web app
  • Dokumentasi tetap bisa dilihat secara offline, dan karena merupakan proyek open source gratis, dapat dimanfaatkan tanpa beban sesuai lingkungan pengembangan

Mencari berbagai dokumentasi API di satu tempat

  • DevDocs menggabungkan berbagai dokumentasi API ke dalam satu antarmuka pencarian yang cepat dan tertata
  • Layar default menampilkan dokumentasi CSS, HTML, HTTP, JavaScript, dan Web APIs
  • Di Preferences, Anda bisa mengaktifkan lebih banyak dokumentasi dan melakukan kustomisasi UI

Cara mencari dan menavigasi

  • Pencarian mendukung fuzzy matching
    • Misalnya, dengan mengetik bgcp, Anda bisa menemukan background-clip
  • Jika ingin mencari hanya di dalam dokumentasi tertentu, masukkan nama atau singkatan dokumentasi lalu persempit cakupan pencarian dengan Tab
  • Pencarian dari address bar browser juga dapat digunakan, dan cara pengaturannya bisa dilihat di panduan

Penggunaan berfokus keyboard

  • Navigasi dan pencarian dapat dilakukan tanpa mouse
  • Lihat daftar shortcut keyboard atau tekan ? untuk memeriksa shortcut yang tersedia

Dukungan offline dan instalasi

  • DevDocs juga berjalan secara offline
  • Dapat digunakan di mobile dan diinstal sebagai web app

Proyek open source gratis

Bacaan terkait

1 komentar

 
GN⁺ 2024-01-14
Opini Hacker News

  • Saya salah satu dari sedikit maintainer DevDocs
    Memperbarui dokumentasi agar sesuai dengan rilis baru itu mudah, kecuali jika sistem atau desain dokumentasinya berubah total. Namun, beberapa proyek tampaknya cukup sering melakukan perombakan seperti redesign react.dev
    Beberapa generator dokumentasi membuat nama kelas acak seperti .gtWOdv, .ezMiXD, .gOhcvK yang dihasilkan Gatsby di docs.npmjs.com, sehingga pekerjaan membersihkan hal-hal yang tidak perlu seperti navigasi halaman menjadi merepotkan dan rapuh
    Setiap bulan kami membuat daftar dokumentasi usang secara otomatis, dan daftar terbarunya ada di sini: https://github.com/freeCodeCamp/devdocs/issues/2105
    Bantuan selalu diterima

    • simon04, pekerjaan yang dilakukan para maintainer sejak dulu sekali membuat perbedaan besar pada karier saya, dan belakangan juga pada hidup saya
      Bisa membaca dokumentasi offline saat pulang-pergi kerja benar-benar penting ketika saya sedang mengerjakan tugas perangkat lunak yang mendadak
      Mungkin Anda tidak menghasilkan uang sepeser pun dengan membantu devdocs, tetapi saya harap Anda tahu bahwa itu benar-benar membantu orang sungguhan
    • Secara pribadi saya cukup frustrasi dengan aplikasi ini. Ini salah satu sumber dokumentasi terbaik, tetapi jadi nyaris tidak bisa dipakai karena tidak bisa mempertahankan daftar dokumentasi yang saya pilih
      Hampir setiap kali berkunjung, saya harus memilih ulang stack yang saya pakai dari awal. Memang bagus, tapi tidak cukup bagus untuk terus mengulang itu
      Di tempat lain saya tidak punya masalah cookie atau penyimpanan lokal yang hilang, dan saya memakai Linux Chrome terbaru. Ada dugaan penyebabnya?
    • Bisakah Anda menilai generator dokumentasi berdasarkan kemudahan untuk dikonsumsi?
      Saya ingin tahu bagaimana perbandingan Sphinx, Docsy, MkDocs, Docbook, dan lainnya dari sisi kemudahan ekstraksi secara semantik
    • Saya pernah ditanya dalam wawancara teknis framework apa yang akan saya gunakan untuk melakukan XYZ
      Saya menjawab bahwa saya tidak tahu persis, tetapi akan mencari antarmuka API di devdocs.io untuk memahaminya lebih lanjut
      Pewawancara tidak mengerti maksud saya, jadi saya membukanya langsung di laptop, dan dia tampak cukup terkejut
      Tentu saja saya tidak mendapatkan pekerjaan itu, tetapi rasanya cukup keren bisa menyebarkan pengetahuan ke sisi lain meja wawancara
    • Situs ini tetap hidup berkat kontribusi seperti ini, dan hasilnya membuat saya ingin mempresentasikan pembaruan-pembaruan yang saya sukai sejak Python 3.8
      Saya sebenarnya bisa mencari datanya sendiri, tetapi ini membuat perbandingan antarversi jadi sangat nyaman

  • Saya kembali melihat tulisan blog “SWEs want offline docs” yang saya tulis beberapa bulan lalu: https://technicalwriting.tools/posts/offline-docs/
    Adakah teknologi mirip RSS yang bisa memberi tahu bahwa dokumentasi cocok untuk dikonsumsi secara offline? Bukan sesuatu seperti service worker, melainkan format terstandarisasi yang memungkinkan pengguna membaca dokumentasi secara offline
    Sejauh ini yang pernah saya lihat hanya PDF dan situs HTML mandiri yang dibungkus ZIP. Adakah yang lain? Ini memang pemikiran yang belum matang, tetapi saya penasaran apakah sebenarnya sudah ada dan saya saja yang belum tahu

    • Saya tidak yakin ada yang lebih baik daripada ZIP. Situs web kami[0] berisi dokumentasi game engine, dokumentasi paket Zig, dan sebagainya, dan kami menaruh tautan “offline version of this site” di footer untuk menyediakan file ZIP sekitar 80MB
      Kesulitan dengan ZIP adalah sulit menyesuaikannya dengan apakah pengguna ingin semua gambar, semua versi dokumentasi, atau hanya versi tertentu. Meski begitu, ZIP masih tampak seperti pilihan terbaik
      [0] https://machengine.org/
    • Ini bukan jawaban lengkap, tetapi standar untuk dokumentasi offline dan teks untuk konsumsi lokal/offline adalah Markdown, atau setidaknya seharusnya begitu. Bagaimanapun saya hampir selalu menulis hanya dalam Markdown, biasanya memakai http://obsidian.md
      Layanan mirip RSS untuk mengunduh dokumentasi yang paling mendekati setahu saya adalah Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli
    • CHM[0] memang tepat seperti itu, tetapi berpusat pada Windows. Ada contoh tampilannya di penampil native di sini[1]
      Sayang sekali Microsoft meninggalkannya, dan beberapa proyek seperti AutoHotKey masih memakainya
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • Saya sudah memakai Zeal. Memang belum ada semuanya, tetapi itu cukup menenangkan
    • Mungkin hanya saya, tetapi dokumentasi Emacs Info sangat bagus untuk tujuan seperti ini dan tidak mengganggu

  • Saya sedang meninjau checklist sebelum perjalanan panjang. Saya mengunduh dokumentasi bahasa dan API untuk berjaga-jaga kalau ingin ngoding saat di pesawat, dan ingin membagikan alat hebat ini
    Ini memudahkan akses offline ke banyak dokumentasi bahasa dan API. Saya berencana sedikit mengulas Zig dan mencoba melakukan sesuatu yang menyenangkan dengan Vulkan. Selamat Tahun Baru

  • Ini berguna saat ngoding dalam perjalanan. Terutama bagus ketika WiFi tidak stabil
    Saya juga suka karena dokumentasinya terkumpul di satu tempat. Jika man, MDN, dan DevDocs digabung dalam satu antarmuka standar, produktivitas sepertinya akan naik jauh

  • Profesi programmer adalah membuat solusi sistematis untuk masalah yang menjengkelkan, jadi agak mengejutkan bahwa kebutuhan paling dasar kita sendiri tampaknya masih belum benar-benar terpecahkan
    Misalnya, DevDocs masih tidak punya cukup banyak library yang sering saya pakai, seperti binding Selenium untuk Python. Saya juga pernah memakai Dash, tetapi karena tidak bisa begitu saja menarik dokumentasi seperti dokumentasi OpenAI, saya akhirnya tetap harus pergi ke situs webnya
    Dengan kata lain, saya kehilangan fitur keren Dash untuk mencari konten terstruktur dengan cepat, jadi rasanya cukup ironis

  • Dalam penerbangan 14 jam baru-baru ini, saya memakai ini. Sehari yang tadinya bakal terbuang berubah menjadi hari yang sangat produktif
    Tidak ada gangguan, dan untuk pertanyaan yang sesekali muncul, dokumentasinya memberi jawaban. Ini juga sangat bagus saat saya memang ingin memutus koneksi

    • Kelihatannya sangat bagus. Kadang, pembatasan pada hal-hal yang bisa dilakukan justru memberi kebebasan
      Apa versi modern dari netbook Linux? Saya ingin mesin kecil yang performanya terlalu rendah untuk menjelajah web, jadi saya tidak punya pilihan selain fokus
      Mungkin Chromebook sudah mengisi posisi itu, tetapi saya tidak ingin memasukkan Google lebih jauh lagi ke dalam hidup saya

  • dedoc adalah alat CLI offline untuk mengunduh, mencari, dan membaca DevDocs dari CLI. Ini cara yang bagus untuk menghindari perpindahan konteks ke browser, sekaligus menghindari gangguan dari browser itu sendiri
    https://github.com/toiletbril/dedoc
    Karena dikompilasi statis dengan Rust, Anda cukup mengunduh dan memasang binarinya

  • Ini seperti Dash versi open source(https://kapeli.com/dash). Bagus juga

    • Sebenarnya sudah ada Dash open source(https://zealdocs.or). Hanya saja, karena perjanjian penggunaan sebagian daftar milik Dash, build untuk Mac tidak disediakan
      Meski begitu, Anda tetap bisa membangunnya sendiri di Mac(https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • Setelah kembali ke Linux, saya sangat merindukan Dash. Di daftar tugas saya ada membuat versi tiruan berbasis web, dan saya juga ingin mendukung paket kustom yang dulu menjadi fitur andalan Dash
      Saya juga ingin menambahkan integrasi Emacs kelas satu supaya tidak perlu berpindah konteks ke browser
      Untuk sekarang saya harus merilis proyek lain dulu, jadi itu harus dikerjakan lagi nanti. Harus selalu membuka satu atau dua tab hexdocs.pm dan MDN sangat menurunkan produktivitas saya
    • Ada juga kumpulan dokumentasi kontribusi pengguna, di-host oleh Dash: https://zealusercontributions.vercel.app/
    • Dash juga bisa mengambil dokumentasi dari readthedocs.org dengan sangat mudah, dan DevDocs tidak punya fitur ini

  • Ini luar biasa. Rasanya saya berharap tahu soal ini lebih awal
    Saat Anda tahu bahwa yang dicari hanyalah hasil dari dokumentasi resmi, ini jauh lebih baik daripada mesin pencari web, dan juga jauh lebih cepat. Saya berpikir untuk mengambil salinannya lalu menjalankannya atau meng-host-nya secara lokal

  • Saya suka alat ini. Saya memakainya setiap hari lewat paket Emacs[1], dan menurut saya alur kerja-nya jauh lebih mulus dibanding solusi sejenis Dash
    [1]: https://github.com/astoff/devdocs.el