DevDocs तकनीकी दस्तावेज़ीकरण प्लेटफ़ॉर्म

 (devdocs.io)
3 पॉइंट द्वारा GN⁺ 2024-01-14 | 1 टिप्पणियां | WhatsApp पर शेयर करें

DevDocs परिचय

  • DevDocs एक ऐसी वेबसाइट है जो विभिन्न API दस्तावेज़ों को तेज़, सुव्यवस्थित और खोजने योग्य इंटरफ़ेस में एकीकृत करती है।
  • उपयोगकर्ता preference settings के ज़रिए और अधिक दस्तावेज़ सक्रिय कर सकते हैं और UI को customize कर सकते हैं।
  • माउस का उपयोग किए बिना भी keyboard shortcuts के माध्यम से साइट को कुशलता से इस्तेमाल किया जा सकता है।

खोज सुविधा

  • खोज में fuzzy matching समर्थित है, उदाहरण के लिए "bgcp" टाइप करने पर "background-clip" दिखाई देता है।
  • किसी विशेष दस्तावेज़ में खोजने के लिए दस्तावेज़ का नाम या उसका abbreviation दर्ज करके Tab key दबाएँ।
  • उपयोगकर्ता अपने browser address bar का उपयोग करके खोज करने का तरीका भी सीख सकते हैं।

अतिरिक्त जानकारी

  • DevDocs offline भी काम करता है, mobile पर इस्तेमाल किया जा सकता है, और web app के रूप में install किया जा सकता है।
  • नवीनतम अपडेट पाने के लिए @DevDocs को follow किया जा सकता है।
  • DevDocs मुफ़्त है और open source के रूप में उपलब्ध है।
  • जो लोग coding में नए हैं, उनके लिए freeCodeCamp के open source curriculum को देखने की सिफारिश की जाती है।

GN⁺ की राय

  • DevDocs डेवलपर्स के लिए एक आवश्यक टूल है, जो विभिन्न programming languages और frameworks के दस्तावेज़ों को एक ही जगह पर आसानी से उपलब्ध कराता है।
  • keyboard shortcuts और fuzzy matching search feature डेवलपर्स की कार्यकुशलता बढ़ाने वाले महत्वपूर्ण फीचर हैं।
  • offline access और mobile compatibility उपयोगकर्ताओं को कहीं से भी जानकारी तक पहुँचने में सक्षम बनाते हैं, जिससे DevDocs और भी उपयोगी हो जाता है।

संबंधित पढ़ाई

1 टिप्पणियां

 
GN⁺ 2024-01-14
Hacker News की राय

  • एक maintainer की राय:

    • नए release के लिए documentation update करना आसान होता है, जब तक documentation system या design को दोबारा न लिखा जाए.
    • कुछ project नियमित रूप से documentation system बदलते हैं.
    • documentation generator मनमाने class name बना देता है, जिससे docs को व्यवस्थित करना झंझटपूर्ण हो जाता है.
    • हर महीने पुरानी docs की सूची अपने-आप बनाई जाती है, और इसमें मदद की ज़रूरत है.

  • offline docs पर ब्लॉग पोस्ट को फिर से देखने वाले एक उपयोगकर्ता की राय:

    • वे सोचते हैं कि क्या ऐसी कोई technology है जो docs को offline इस्तेमाल करना आसान बनाती हो.
    • वे पूछते हैं कि क्या कोई standardized format है, या ऐसा कुछ है जिसके बारे में उन्हें अभी पता नहीं.

  • लंबी दूरी की यात्रा से पहले checklist देखने वाले एक उपयोगकर्ता की राय:

    • उन्होंने ऐसे tool साझा किए जो offline language और API docs तक आसानी से पहुँचने देते हैं.
    • वे Zig और Vulkan का उपयोग करके development करने की योजना बना रहे हैं.

  • चलते-फिरते programming करते समय इसे उपयोगी पाने वाले एक उपयोगकर्ता की राय:

    • WiFi अस्थिर होने पर यह खास तौर पर उपयोगी है.
    • docs को एकीकृत करके एक single standard interface बना दिया जाए, तो productivity काफ़ी बढ़ जाएगी.

  • इस बात पर हैरान एक उपयोगकर्ता की राय कि programmer की बुनियादी ज़रूरतें system के स्तर पर पूरी नहीं की गईं:

    • devdocs में वे library शामिल नहीं हैं जिन्हें वे नियमित रूप से इस्तेमाल करते हैं.
    • उन्होंने Dash आज़माया, लेकिन openai docs सीधे हासिल नहीं कर सके.

  • 14 घंटे की उड़ान के दौरान इस tool का उपयोग कर दिन को productive बनाने वाले एक उपयोगकर्ता की राय:

    • बिना distraction के docs का सवालों का जवाब देना इसे बहुत उपयोगी बनाता है.

  • offline CLI tool dedoc के बारे में एक उपयोगकर्ता की राय:

    • browser पर context switch से बचते हुए, CLI में devdocs को download, search और read किया जा सकता है.
    • यह Rust में statically compile किया गया है, इसलिए binary download करके install किया जा सकता है.

  • open source Dash-जैसे tool के बारे में एक उपयोगकर्ता की राय:

    • यह बहुत बढ़िया है.

  • इस tool के लिए आभार व्यक्त करने वाली राय:

    • जब केवल official docs में ही नतीजे मिलते हैं, तब यह web search engine से कहीं बेहतर है.
    • वे इसे local में copy करके चलाने या host करने की योजना बना रहे हैं.

  • एक उपयोगकर्ता की राय जो इसे रोज़ाना Emacs package के ज़रिए इस्तेमाल करते हैं:

    • Dash जैसी solution की तुलना में workflow कहीं अधिक smooth है.