DevDocs: แพลตฟอร์มเอกสารสำหรับค้นหาเอกสารเทคโนโลยีหลากหลายไว้ในที่เดียว

 (devdocs.io)
3 คะแนน โดย GN⁺ 2024-01-14 | 1 ความคิดเห็น | แชร์ทาง WhatsApp
  • รวม เอกสาร API ที่นักพัฒนาค้นหาบ่อยไว้ในที่เดียว เพื่อให้ค้นหาได้อย่างรวดเร็ว และช่วยลดต้นทุนในการสลับไปมาระหว่างเอกสารของแต่ละภาษาและเฟรมเวิร์ก
  • โดยค่าเริ่มต้นจะแสดง CSS, HTML, HTTP, JavaScript และ Web APIs และสามารถเปิดใช้งานเอกสารที่ต้องการเพิ่มเติมรวมถึงปรับหน้าจอได้ใน Preferences
  • เข้าถึงรายการที่ต้องการได้เร็วขึ้นด้วย fuzzy matching เช่นใช้ bgcp เพื่อหา background-clip และการกำหนดขอบเขตการค้นหาตามเอกสาร
  • รองรับ คีย์ลัดแป้นพิมพ์ เพื่อใช้งานโดยไม่ต้องใช้เมาส์, การค้นหาจากแถบที่อยู่ของเบราว์เซอร์, การใช้งานบนมือถือ และการติดตั้งเป็นเว็บแอป
  • สามารถดูเอกสารได้แม้ขณะออฟไลน์ และเป็นโปรเจกต์โอเพนซอร์สฟรี จึงนำไปใช้ให้เหมาะกับสภาพแวดล้อมการพัฒนาได้อย่างสบายใจ

ค้นหาเอกสาร API หลายรายการได้ในที่เดียว

  • DevDocs รวม เอกสาร API หลายรายการไว้ในอินเทอร์เฟซค้นหาเดียวที่รวดเร็วและเป็นระเบียบ
  • หน้าจอเริ่มต้นจะแสดงเอกสาร CSS, HTML, HTTP, JavaScript และ Web APIs
  • สามารถเปิดใช้งานเอกสารเพิ่มเติมและทำ UI customization ได้ใน Preferences

วิธีค้นหาและนำทาง

  • การค้นหารองรับ fuzzy matching
    • ตัวอย่างเช่น หากป้อน bgcp จะสามารถหา background-clip ได้
  • เมื่อต้องการค้นหาเฉพาะภายในเอกสารใดเอกสารหนึ่ง ให้ป้อนชื่อเอกสารหรือตัวย่อ แล้วใช้ Tab เพื่อจำกัดขอบเขตการค้นหา
  • สามารถใช้ การค้นหาจากแถบที่อยู่ ของเบราว์เซอร์ได้เช่นกัน โดยดูวิธีตั้งค่าได้จาก คู่มือ

การใช้งานโดยเน้นแป้นพิมพ์

  • สามารถนำทางและค้นหาได้โดยไม่ต้องใช้เมาส์
  • ดูรายการ คีย์ลัดแป้นพิมพ์ หรือกด ? เพื่อตรวจสอบคีย์ลัดที่ใช้งานได้

รองรับออฟไลน์และการติดตั้ง

  • DevDocs ทำงานได้แม้ ออฟไลน์
  • ใช้งานบนมือถือได้ และติดตั้งเป็น เว็บแอป ได้

โปรเจกต์โอเพนซอร์สฟรี

  • DevDocs ให้บริการฟรี
  • ซอร์สโค้ดเผยแพร่อยู่บน GitHub
  • ติดตามข่าวล่าสุดได้ที่บัญชี @DevDocs
  • ยังมีการเชื่อมไปยัง หลักสูตรโอเพนซอร์สของ freeCodeCamp สำหรับผู้ใช้ที่เพิ่งเริ่มเขียนโค้ดด้วย

บทความที่เกี่ยวข้อง

1 ความคิดเห็น

 
GN⁺ 2024-01-14
ความคิดเห็นจาก Hacker News

  • ผมเป็นหนึ่งใน ผู้ดูแล DevDocs ที่มีอยู่ไม่กี่คน
    การอัปเดตเอกสารให้ทันกับรีลีสใหม่ทำได้ง่าย ถ้าไม่ได้มีการเปลี่ยนทั้งระบบเอกสารหรือดีไซน์ทั้งหมด อย่างไรก็ตาม ดูเหมือนว่าบางโปรเจกต์จะยกเครื่องแบบนี้ค่อนข้างบ่อย เช่นการรีดีไซน์ react.dev
    ตัวสร้างเอกสารบางตัวสร้าง ชื่อคลาสแบบสุ่ม เช่น .gtWOdv, .ezMiXD, .gOhcvK ที่ Gatsby สร้างบน docs.npmjs.com ทำให้งานตัดเนื้อหาที่ไม่จำเป็นอย่าง navigation ของหน้าออกยุ่งยากและไม่เสถียร
    เราสร้างรายการเอกสารที่ล้าสมัยโดยอัตโนมัติทุกเดือน และรายการล่าสุดอยู่ที่นี่: https://github.com/freeCodeCamp/devdocs/issues/2105
    ยินดีรับความช่วยเหลือเสมอ

    • simon04 งานที่ผู้ดูแลทำไว้เมื่อเนิ่นนานมาแล้วส่งผลอย่างมากต่ออาชีพของผม และต่อมาถึงชีวิตของผมด้วย
      การได้อ่าน เอกสารแบบออฟไลน์ ระหว่างเดินทางไปกลับ ตอนที่ต้องรับงานซอฟต์แวร์แบบเร่งด่วน เป็นเรื่องสำคัญมากจริง ๆ
      คุณอาจไม่ได้หาเงินได้แม้แต่บาทเดียวจากการช่วย devdocs แต่ผมอยากให้รู้ไว้จริง ๆ ว่าคุณกำลังช่วยเหลือคนจริง ๆ อยู่
    • แอปนี้สำหรับผมค่อนข้างน่าหงุดหงิด เป็นหนึ่งในแหล่งเอกสารที่ดีที่สุด แต่เพราะมันเก็บรายการเอกสารที่ผมเลือกไว้ไม่ได้ เลยแทบใช้ไม่ได้
      แทบทุกครั้งที่เข้าไป ผมต้องเลือกสแต็กที่ใช้ใหม่ตั้งแต่ต้น มันยอดเยี่ยมก็จริง แต่ไม่ได้ยอดเยี่ยมพอให้ทำซ้ำแบบนั้นเรื่อย ๆ
      ที่อื่นผมไม่มีปัญหาคุกกี้หรือ local storage หาย และใช้ Chrome บน Linux เวอร์ชันล่าสุดอยู่ พอจะเดาสาเหตุได้ไหม?
    • ช่วยประเมินตัวสร้างเอกสารตาม ความง่ายในการนำไปบริโภค ได้ไหม?
      อยากรู้ว่า Sphinx, Docsy, MkDocs, Docbook ฯลฯ เทียบกันอย่างไรในแง่การดึงข้อมูลเชิงความหมายออกมาได้ง่าย
    • เคยถูกถามในการสัมภาษณ์งานเทคนิคว่า ถ้าใช้เฟรมเวิร์กหนึ่ง ๆ จะทำ XYZ อย่างไร
      ผมตอบว่าไม่รู้แน่ชัด แต่จะลองไปดู API interface ใน devdocs.io เพื่อทำความเข้าใจให้มากขึ้น
      ผู้สัมภาษณ์ไม่เข้าใจว่าหมายถึงอะไร เลยเปิดดูเองบนแล็ปท็อป แล้วก็ค่อนข้างทึ่ง
      แน่นอนว่าผมไม่ได้งานนั้น แต่การได้เผยแพร่ความรู้ไปยังฝั่งตรงข้ามโต๊ะสัมภาษณ์ก็เป็นเรื่องที่เท่มาก
    • ที่ไซต์นี้ยังอยู่ได้ก็เพราะการมีส่วนร่วมแบบนี้ และผลลัพธ์คือผมเริ่มอยากนำเสนอเกี่ยวกับอัปเดตต่าง ๆ ที่ผมชอบหลัง Python 3.8
      ข้อมูลน่าจะหาเองได้อยู่แล้ว แต่ทำให้การเปรียบเทียบตามเวอร์ชัน สะดวกมาก

  • กลับไปอ่านบล็อกโพสต์ “SWEs want offline docs” ที่เขียนไว้เมื่อไม่กี่เดือนก่อน: https://technicalwriting.tools/posts/offline-docs/
    มีเทคโนโลยีคล้าย RSS ที่ใช้บอกได้ไหมว่าเอกสาร เหมาะสำหรับการใช้งานแบบออฟไลน์? ไม่ได้หมายถึง service worker แต่หมายถึงรูปแบบมาตรฐานที่ทำให้ผู้ใช้สามารถอ่านเอกสารแบบออฟไลน์ได้
    เท่าที่เห็นมามีแค่ PDF กับไซต์ HTML แบบสแตนด์อโลนที่บีบรวมเป็น ZIP เท่านั้น มีอย่างอื่นไหม? เป็นความคิดที่ยังไม่สุกดี แต่อยากรู้ว่ามันมีอยู่แล้วแต่ผมไม่รู้หรือเปล่า

    • ผมไม่แน่ใจว่ามีอะไรดีกว่า ZIP ไหม เว็บไซต์ของเรา[0] มีเอกสารเอนจินเกม เอกสารแพ็กเกจ Zig ฯลฯ และวางลิงก์ “offline version of this site” ไว้ที่ footer เพื่อให้ไฟล์ ZIP ขนาดประมาณ 80MB
      ความยากของ ZIP คือปรับให้ตรงกับความต้องการได้ยากว่า ผู้ใช้ต้องการรูปทั้งหมดหรือไม่ ต้องการเอกสารทุกเวอร์ชันหรือไม่ หรือแค่เวอร์ชันใดเวอร์ชันหนึ่ง แต่ถึงอย่างนั้น ZIP ก็ยังดูเป็นทางเลือกที่ดีที่สุด
      [0] https://machengine.org/
    • ไม่ใช่คำตอบที่สมบูรณ์ แต่สำหรับเอกสารออฟไลน์และข้อความสำหรับใช้งานแบบโลคัล/ออฟไลน์ มาตรฐานน่าจะเป็น Markdown หรือผมหวังให้เป็นอย่างนั้น อย่างไรเสียผมก็แทบจะเขียนเป็น Markdown ตลอดอยู่แล้ว ปกติใช้ http://obsidian.md
      สิ่งที่ใกล้เคียงที่สุดที่ผมรู้จักกับบริการคล้าย RSS สำหรับดาวน์โหลดเอกสารคือ Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli
    • CHM[0] คือสิ่งนั้นเลย แต่เน้น Windows เป็นหลัก ตัวอย่างว่ามันหน้าตาเป็นอย่างไรใน native viewer ดูได้ที่นี่[1]
      น่าเสียดายที่ Microsoft ทิ้งมันไปแล้ว และบางโปรเจกต์อย่าง AutoHotKey ก็ยังใช้อยู่
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • ผมใช้ Zeal อยู่ ถึงจะยังไม่ได้มีทุกอย่าง แต่ก็ทำให้สบายใจขึ้นมาก
    • อาจจะเป็นแค่ผมก็ได้ แต่ เอกสาร Emacs Info เหมาะกับงานแบบนี้มากจริง ๆ และไม่รบกวนการทำงานด้วย

  • กำลังไล่เช็กลิสต์ก่อนออกเดินทางไกล ผมดาวน์โหลดเอกสารภาษาและ API ไว้ เผื่ออยากพัฒนาระหว่างอยู่บนเครื่องบิน และอยากแชร์เครื่องมือยอดเยี่ยมนี้
    มันช่วยให้ เข้าถึงแบบออฟไลน์ ได้ง่ายสำหรับเอกสารของหลายภาษาและ API ผมตั้งใจจะทบทวน Zig สักหน่อย และลองทำอะไรสนุก ๆ กับ Vulkan สวัสดีปีใหม่

  • มีประโยชน์ตอนเขียนโปรแกรมระหว่างเดินทาง โดยเฉพาะเมื่อ WiFi ไม่เสถียร
    ผมชอบด้วยที่เอกสารถูกรวมไว้ในที่เดียว ถ้า man, MDN และ DevDocs ถูกรวมเป็นอินเทอร์เฟซมาตรฐานเดียวกันได้ ผลิตภาพน่าจะเพิ่มขึ้นมาก

  • ผมค่อนข้างแปลกใจที่โปรแกรมเมอร์มีงานหลักคือสร้างวิธีแก้ปัญหาอย่างเป็นระบบให้กับปัญหาน่ารำคาญ แต่ความต้องการพื้นฐานที่สุดของเราเองกลับยังดูเหมือนไม่ได้รับการแก้ไขอย่างเหมาะสม
    ตัวอย่างเช่น DevDocs ขาดไลบรารีที่ผมใช้บ่อยไปค่อนข้างมาก เช่น Selenium bindings สำหรับ Python ผมลองใช้ Dash แล้วเหมือนกัน แต่ก็ยังดึงเอกสารอย่าง OpenAI docs เข้ามาไม่ได้ สุดท้ายก็ต้องไปที่เว็บไซต์อยู่ดี
    นั่นหมายความว่าความสามารถเจ๋ง ๆ ของ Dash ในการค้นหาเนื้อหาที่มีโครงสร้างอย่างรวดเร็วถูกพรากไป จึงรู้สึกค่อนข้างย้อนแย้ง

  • เพิ่งใช้สิ่งนี้ระหว่าง เที่ยวบิน 14 ชั่วโมง เมื่อไม่นานมานี้ จากวันที่น่าจะเสียเปล่า กลายเป็นวันที่ทำงานได้อย่างมีประสิทธิภาพมาก
    ไม่มีสิ่งรบกวน และเวลามีคำถามขึ้นมาเป็นครั้งคราว เอกสารก็ช่วยตอบให้ได้ เหมาะมากเวลาที่แค่อยากตัดการเชื่อมต่อด้วย

    • ดูดีมากจริง ๆ บางครั้งการมีข้อจำกัดในสิ่งที่ทำได้กลับให้ความรู้สึกเป็นอิสระเสียอีก
      เน็ตบุ๊ก Linux ในยุคปัจจุบันคืออะไรนะ? อยากได้เครื่องเล็ก ๆ ที่ประสิทธิภาพต่ำเกินกว่าจะท่องเว็บได้สะดวก จนต้องโฟกัสอย่างเดียว
      Chromebook อาจเข้ามาแทนที่ตำแหน่งนั้นแล้วก็ได้ แต่ผมไม่อยากให้ Google เข้ามาอยู่ในชีวิตมากกว่านี้

  • dedoc เป็นเครื่องมือ CLI แบบออฟไลน์ที่ใช้ดาวน์โหลด ค้นหา และอ่าน DevDocs ได้จาก CLI เป็นวิธีที่ดีในการเลี่ยงการสลับบริบทไปเปิดเบราว์เซอร์ และยังเลี่ยงสิ่งรบกวนจากตัวเบราว์เซอร์เองได้ด้วย
    https://github.com/toiletbril/dedoc
    คอมไพล์แบบสแตติกด้วย Rust จึงแค่ดาวน์โหลดไบนารีมาติดตั้งก็ใช้งานได้

  • เหมือน Dash แบบโอเพนซอร์ส(https://kapeli.com/dash) เลย ดีจัง

    • มี Dash แบบโอเพนซอร์สอยู่แล้ว(https://zealdocs.or) เพียงแต่ไม่มีบิลด์สำหรับ Mac เพราะมีข้อตกลงเรื่องการใช้รายการบางส่วนของ Dash
      ถึงอย่างนั้นก็ยังบิลด์เองบน Mac ได้(https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • หลังจากกลับมาใช้ Linux ก็คิดถึง Dash มาก ในรายการสิ่งที่ต้องทำมีการสร้าง โคลนแบบเว็บ อยู่ และตั้งใจจะรองรับแพ็กเกจแบบกำหนดเอง ซึ่งเคยเป็นฟีเจอร์เด็ดของ Dash ด้วย
      อยากใส่การเชื่อมต่อกับ Emacs ระดับดีที่สุดไว้ด้วย เพื่อไม่ต้องสลับบริบทไปเปิดเบราว์เซอร์
      ตอนนี้กำลังต้องปล่อยโปรเจกต์อื่นก่อน เลยต้องกลับมาทำทีหลัง การต้องเปิดแท็บ hexdocs.pm กับ MDN ค้างไว้ทีละหนึ่งสองแท็บตลอด ทำให้ประสิทธิภาพการทำงานลดลงมาก
    • ยังมีชุดเอกสารที่ผู้ใช้ร่วมกันส่งเข้ามาด้วย โดย Dash เป็นผู้โฮสต์: https://zealusercontributions.vercel.app/
    • Dash สามารถดึงเอกสารจาก readthedocs.org ได้ง่ายมากด้วย แต่ DevDocs ไม่มีฟีเจอร์นี้

  • อันนี้ยอดเยี่ยมมาก ถ้ารู้จักเร็วกว่านี้ก็คงดี
    เวลารู้อยู่แล้วว่าต้องการหาเฉพาะผลลัพธ์จากเอกสารทางการ มันดีกว่าเว็บเสิร์ชเอนจินมาก และเร็วกว่ามากด้วย กำลังคิดว่าจะดาวน์โหลดสำเนามารันในเครื่องหรือโฮสต์เอง

  • ชอบเครื่องมือนี้ ใช้ทุกวันผ่านแพ็กเกจ Emacs[1] และรู้สึกว่า เวิร์กโฟลว์ ลื่นไหลกว่าโซลูชันตระกูล Dash มาก
    [1]: https://github.com/astoff/devdocs.el