DevDocs teknik dokümantasyon platformu

 (devdocs.io)
3 puan yazan GN⁺ 2024-01-14 | 1 yorum | WhatsApp'ta paylaş

DevDocs'a giriş

  • DevDocs, çeşitli API belgelerini hızlı, düzenli ve aranabilir bir arayüzde bir araya getiren bir web sitesidir.
  • Kullanıcılar, tercih ayarları üzerinden daha fazla dokümanı etkinleştirebilir ve arayüzü özelleştirebilir.
  • Fare kullanmadan da klavye kısayolları sayesinde site verimli şekilde kullanılabilir.

Arama özelliği

  • Arama, fuzzy matching destekler; örneğin "bgcp" yazıldığında "background-clip" görünür.
  • Belirli bir dokümanda arama yapmak için doküman adını veya kısaltmasını yazdıktan sonra Tab tuşuna basmak yeterlidir.
  • Kullanıcının tarayıcı adres çubuğunu kullanarak arama yapma yöntemini öğrenmesi de mümkündür.

Ek bilgiler

  • DevDocs çevrimdışı da çalışır, mobilde kullanılabilir ve bir web uygulaması olarak kurulabilir.
  • En son gelişmeleri almak için @DevDocs takip edilebilir.
  • DevDocs ücretsizdir ve açık kaynak olarak sunulur.
  • Kodlamaya yeni başlayanlar için freeCodeCamp'in açık kaynak müfredatına göz atılması önerilir.

GN⁺'nin görüşü

  • DevDocs, geliştiriciler için vazgeçilmez bir araçtır; farklı programlama dilleri ve framework'lere ait dokümanları tek bir yerde kolayca bulmayı sağlar.
  • Klavye kısayolları ve fuzzy matching arama özelliği, geliştiricilerin verimliliğini artıran önemli işlevlerdir.
  • Çevrimdışı erişim ve mobil uyumluluk, kullanıcıların her yerden bilgiye erişebilmesini sağlayarak DevDocs'u daha da kullanışlı hale getirir.

İlgili okumalar

1 yorum

 
GN⁺ 2024-01-14
Hacker News yorumları

  • Bakımcılarından birinin yorumu:

    • Yeni bir sürüm için dokümantasyon güncellemeleri, dokümantasyon sistemi veya tasarımı yeniden yazılmadığı sürece kolaydır.
    • Bazı projeler dokümantasyon sistemini düzenli olarak değiştirir.
    • Dokümantasyon üreticisi rastgele sınıf adları üreterek dokümantasyonu düzenlemeyi zahmetli hale getirir.
    • Her ay eski dokümantasyonların listesini otomatik olarak oluşturuyor ve yardıma ihtiyaç duyuyor.

  • Çevrimdışı dokümantasyon hakkındaki blog yazısını yeniden ziyaret eden bir kullanıcının yorumu:

    • Dokümantasyonu çevrimdışı tüketmeyi kolaylaştıran bir teknoloji olup olmadığını merak ediyor.
    • Standartlaştırılmış bir format olup olmadığını ya da henüz bilmediği bir şey bulunup bulunmadığını soruyor.

  • Uzun bir yolculuk öncesi kontrol listesini gözden geçiren bir kullanıcının yorumu:

    • Çevrimdışıyken dil ve API dokümantasyonuna kolayca erişebileceği bir aracı paylaşıyor.
    • Zig ve Vulkan kullanarak geliştirme yapmayı planlıyor.

  • Hareket halindeyken programlama yaparken bunu faydalı bulan bir kullanıcının yorumu:

    • Özellikle WiFi dengesiz olduğunda çok yararlı.
    • Dokümantasyonları bir araya getirip tek bir standart arayüz haline getirmenin üretkenliği büyük ölçüde artıracağını söylüyor.

  • Programcıların temel bir ihtiyacının sistematik olarak karşılanmamasına şaşıran bir kullanıcının yorumu:

    • devdocs, düzenli kullandığı kütüphaneleri içermiyor.
    • Dash'i denemiş ama openai dokümantasyonunu doğrudan alamamış.

  • 14 saatlik bir uçuş sırasında bu aracı kullanarak günü verimli geçiren bir kullanıcının yorumu:

    • Dikkat dağıtıcı unsurlar olmadan dokümantasyonun sorularını yanıtlayabilmesi çok faydalı.

  • Çevrimdışı CLI aracı dedoc hakkındaki bir kullanıcının yorumu:

    • Tarayıcıya bağlam değiştirmeyi önlüyor; CLI üzerinden devdocs'u indirip arayabiliyor ve okuyabiliyor.
    • Rust ile statik olarak derlenmiş, bu yüzden binary dosyasını indirip kurabiliyorsunuz.

  • Açık kaynaklı, Dash benzeri araçlar hakkındaki bir kullanıcının yorumu:

    • Çok iyi.

  • Bu araç için teşekkür eden bir yorum:

    • Sonuçları yalnızca resmi dokümantasyonda ararken web arama motorlarından çok daha iyi.
    • Yerelde kopyalayıp çalıştırmayı ya da host etmeyi planlıyor.

  • Bunu her gün Emacs paketi üzerinden kullanan bir kullanıcının yorumu:

    • Dash benzeri çözümlerle kıyaslandığında iş akışı çok daha akıcı.