DevDocs: nền tảng tài liệu cho phép tìm kiếm nhiều tài liệu kỹ thuật ở một nơi

 (devdocs.io)
3 điểm bởi GN⁺ 2024-01-14 | 1 bình luận | Chia sẻ qua WhatsApp
  • Tập hợp tài liệu API mà lập trình viên thường tra cứu vào một nơi để có thể tìm kiếm nhanh, giúp giảm chi phí chuyển đổi khi phải qua lại giữa tài liệu theo ngôn ngữ và framework
  • Mặc định hiển thị CSS, HTML, HTTP, JavaScript, Web APIs; trong Preferences bạn có thể bật thêm tài liệu cần thiết và điều chỉnh màn hình
  • Hỗ trợ fuzzy matching để tìm background-clip bằng bgcp, đồng thời cho phép chỉ định phạm vi tìm kiếm theo từng bộ tài liệu để truy cập mục mong muốn nhanh hơn
  • Hỗ trợ phím tắt, tìm kiếm từ thanh địa chỉ trình duyệt, sử dụng trên di động và cài đặt như ứng dụng web mà không cần dùng chuột
  • Có thể xem tài liệu cả khi ngoại tuyến, và vì là dự án mã nguồn mở miễn phí nên có thể sử dụng linh hoạt theo môi trường phát triển

Tìm kiếm nhiều tài liệu API ở một nơi

  • DevDocs kết hợp nhiều tài liệu API vào một giao diện tìm kiếm duy nhất, nhanh và gọn gàng
  • Màn hình mặc định hiển thị tài liệu CSS, HTML, HTTP, JavaScript, Web APIs
  • Trong Preferences, bạn có thể bật thêm nhiều tài liệu hơn và tùy biến UI

Cách tìm kiếm và điều hướng

  • Tìm kiếm hỗ trợ fuzzy matching
    • Ví dụ, nhập bgcp có thể tìm ra background-clip
  • Khi chỉ muốn tìm trong một bộ tài liệu cụ thể, hãy nhập tên hoặc viết tắt của tài liệu rồi nhấn Tab để thu hẹp phạm vi tìm kiếm
  • Bạn cũng có thể dùng tìm kiếm từ thanh địa chỉ của trình duyệt; cách thiết lập có trong hướng dẫn

Sử dụng theo hướng bàn phím

  • Bạn có thể điều hướng và tìm kiếm mà không cần chuột
  • Xem danh sách phím tắt hoặc nhấn ? để kiểm tra các phím tắt khả dụng

Hỗ trợ ngoại tuyến và cài đặt

  • DevDocs hoạt động cả ngoại tuyến
  • Có thể sử dụng trên di động và cài đặt dưới dạng ứng dụng web

Dự án mã nguồn mở miễn phí

Bài viết liên quan

1 bình luận

 
GN⁺ 2024-01-14
Ý kiến trên Hacker News

  • Tôi là một trong số ít người bảo trì DevDocs
    Nếu không phải là trường hợp hệ thống tài liệu hoặc thiết kế bị thay đổi toàn bộ, việc cập nhật tài liệu theo bản phát hành mới khá dễ. Tuy nhiên, có vẻ một số dự án thực hiện các đợt cải tổ như vậy khá thường xuyên, như lần redesign react.dev
    Một số trình tạo tài liệu tạo ra tên class ngẫu nhiên như .gtWOdv, .ezMiXD, .gOhcvK mà Gatsby tạo trên docs.npmjs.com, khiến việc loại bỏ các nội dung không cần thiết như điều hướng trong trang trở nên phiền phức và thiếu ổn định
    Chúng tôi tự động tạo danh sách tài liệu đã cũ hằng tháng, danh sách mới nhất ở đây: https://github.com/freeCodeCamp/devdocs/issues/2105
    Mọi sự trợ giúp luôn được hoan nghênh

    • simon04, công việc mà các maintainer đã làm từ rất lâu trước đây đã tạo ra khác biệt lớn cho sự nghiệp của tôi, và về sau là cả cuộc sống của tôi
      Việc có thể đọc tài liệu offline khi đi làm trong lúc đang gấp rút đảm nhận một công việc phần mềm thật sự rất quan trọng
      Có thể bạn đã không kiếm được đồng nào từ việc giúp devdocs, nhưng tôi rất mong bạn biết rằng bạn đang giúp được những con người thật
    • Cá nhân tôi thấy app này khá bực bội. Đây là một trong những nguồn tài liệu tốt nhất, nhưng vì nó không giữ được danh sách tài liệu tôi đã chọn nên gần như không dùng nổi
      Hầu như mỗi lần truy cập tôi đều phải chọn lại stack mình dùng từ đầu. Nó tuyệt vời, nhưng chưa tuyệt vời đến mức đáng để lặp lại việc đó mãi
      Tôi không gặp vấn đề cookie hay local storage bị mất ở nơi khác, và đang dùng Chrome Linux bản mới nhất. Có đoán được nguyên nhân gì không?
    • Bạn có thể đánh giá các trình tạo tài liệu theo mức độ dễ tiêu thụ không?
      Tôi muốn biết Sphinx, Docsy, MkDocs, Docbook, v.v. so sánh với nhau thế nào về mặt dễ trích xuất theo ngữ nghĩa
    • Trong một buổi phỏng vấn kỹ thuật, tôi từng được hỏi sẽ làm XYZ bằng framework nào đó như thế nào
      Tôi trả lời rằng mình không biết chính xác, nhưng sẽ tra giao diện API trên devdocs.io để hiểu thêm
      Người phỏng vấn không hiểu ý tôi nên đã tự mở bằng laptop, và tỏ ra khá ngạc nhiên
      Dĩ nhiên tôi không nhận được công việc đó, nhưng việc truyền bá kiến thức sang phía bên kia bàn phỏng vấn cũng khá thú vị
    • Việc trang này vẫn sống được là nhờ những đóng góp như thế này, và nhờ vậy tôi muốn thử trình bày về các cập nhật tôi thích kể từ Python 3.8
      Tôi có thể tự tìm dữ liệu, nhưng nó giúp việc so sánh theo phiên bản trở nên rất tiện

  • Tôi đã xem lại bài blog “SWEs want offline docs” viết vài tháng trước: https://technicalwriting.tools/posts/offline-docs/
    Có công nghệ nào giống RSS để báo rằng tài liệu phù hợp để tiêu thụ offline không? Tôi không nói đến thứ như service worker, mà là một định dạng được chuẩn hóa để người dùng có thể đọc tài liệu offline
    Đến giờ tôi chỉ thấy PDF và các site HTML độc lập được đóng gói thành ZIP. Có thứ nào khác không? Đây mới là ý nghĩ chưa chín, nhưng tôi tò mò không biết đã có rồi mà mình không biết hay chưa

    • Tôi không chắc có gì tốt hơn ZIP không. Website của chúng tôi[0] có tài liệu game engine, tài liệu package Zig, v.v., và ở footer có liên kết “offline version of this site” cung cấp một file ZIP khoảng 80MB
      Cái khó của ZIP là khó điều chỉnh theo việc người dùng có muốn toàn bộ hình ảnh, muốn tài liệu của mọi phiên bản, hay chỉ muốn một phiên bản cụ thể. Dù vậy ZIP vẫn có vẻ là lựa chọn tốt nhất
      [0] https://machengine.org/
    • Không phải câu trả lời hoàn chỉnh, nhưng tiêu chuẩn cho tài liệu offline và văn bản dùng local/offline là Markdown, hoặc tôi mong nó sẽ là như vậy. Dù sao tôi hầu như luôn chỉ viết bằng Markdown, thường dùng http://obsidian.md
      Thứ gần nhất mà tôi biết với một dịch vụ kiểu RSS để tải tài liệu là Dash for macOS - API Documentation Browser, Snippet Manager - Kapeli
    • CHM[0] chính là thứ như vậy, nhưng thiên về Windows. Có ví dụ ở đây[1] về việc nó trông thế nào trong trình xem native
      Thật tiếc là Microsoft đã bỏ rơi nó, và một số dự án như AutoHotKey vẫn còn dùng
      [0] https://en.wikipedia.org/wiki/Microsoft_Compiled_HTML_Help
      [1] https://www.helpsmith.com/images/ss/chm-help1.png
    • Tôi đã dùng Zeal. Vẫn chưa có mọi thứ, nhưng cảm thấy yên tâm hơn khá nhiều
    • Có thể chỉ mình tôi như vậy, nhưng tài liệu Emacs Info thật sự rất tốt cho mục đích này và cũng không gây vướng víu

  • Tôi đang rà qua checklist trước một chuyến đi dài. Tôi đang tải tài liệu ngôn ngữ và API để phòng khi muốn code trên máy bay, và muốn chia sẻ công cụ tuyệt vời này
    Nó giúp truy cập offline dễ dàng vào tài liệu của nhiều ngôn ngữ và API. Tôi định ôn lại Zig một chút và làm gì đó thú vị với Vulkan. Chúc mừng năm mới

  • Nó hữu ích khi lập trình lúc di chuyển. Đặc biệt tốt khi WiFi không ổn định
    Tôi cũng thích việc tài liệu được gom về một chỗ. Nếu man, MDN và DevDocs được hợp nhất trong một giao diện chuẩn, năng suất chắc sẽ tăng đáng kể

  • Tôi hơi ngạc nhiên vì lập trình viên vốn có nghề chính là tạo ra các giải pháp có hệ thống cho những vấn đề phiền toái, nhưng chính những nhu cầu cơ bản nhất của chúng ta dường như vẫn chưa được giải quyết đàng hoàng
    Ví dụ DevDocs thiếu khá nhiều thư viện tôi hay dùng, như Selenium bindings cho Python. Tôi cũng đã thử Dash, nhưng không thể đơn giản import những thứ như tài liệu OpenAI, nên cuối cùng vẫn phải vào website
    Nói cách khác, tôi bị mất đi tính năng tuyệt vời của Dash là tìm kiếm nhanh nội dung có cấu trúc, nên cảm thấy khá mỉa mai

  • Gần đây tôi đã dùng cái này trong chuyến bay 14 tiếng. Một ngày lẽ ra bị lãng phí đã biến thành một ngày cực kỳ năng suất
    Không có yếu tố gây xao nhãng, và tài liệu đã trả lời những câu hỏi thỉnh thoảng nảy ra. Nó cũng thực sự tuyệt khi bạn chỉ muốn ngắt kết nối

    • Trông thật sự rất hay. Đôi khi việc bị giới hạn những gì có thể làm lại đem đến sự tự do
      Netbook Linux phiên bản hiện đại sẽ là gì nhỉ? Tôi muốn một chiếc máy nhỏ có hiệu năng quá thấp để lướt web, khiến mình buộc phải tập trung
      Chromebook có thể đã chiếm vị trí đó, nhưng tôi không muốn đưa thêm Google vào cuộc sống của mình

  • dedoc là một công cụ CLI ngoại tuyến cho phép tải xuống, tìm kiếm và đọc DevDocs từ CLI. Đây là cách hay để tránh chuyển ngữ cảnh sang trình duyệt, đồng thời tránh cả những yếu tố gây xao nhãng của chính trình duyệt
    https://github.com/toiletbril/dedoc
    Nó được biên dịch tĩnh bằng Rust, nên chỉ cần tải binary về và cài đặt

  • Giống Dash mã nguồn mở (https://kapeli.com/dash). Hay đấy

    • Đã có Dash mã nguồn mở rồi (https://zealdocs.or). Tuy nhiên do thỏa thuận sử dụng một phần danh mục của Dash nên họ không cung cấp bản build cho Mac
      Dù vậy vẫn có thể tự build trên Mac (https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...)
    • Sau khi quay lại Linux, tôi đã rất nhớ Dash. Trong danh sách việc cần làm của tôi có mục tạo một bản sao dựa trên web, và tôi cũng định hỗ trợ các gói tùy chỉnh, vốn là tính năng sát thủ của Dash
      Tôi cũng muốn thêm tích hợp Emacs ở mức tốt nhất để không phải chuyển ngữ cảnh sang trình duyệt
      Hiện tại tôi đang ưu tiên ra mắt một dự án khác, nên sẽ phải quay lại việc này sau. Việc luôn phải mở một hai tab hexdocs.pm và MDN đã làm năng suất của tôi giảm đáng kể
    • Cũng có các bộ tài liệu do người dùng đóng góp, được Dash lưu trữ: https://zealusercontributions.vercel.app/
    • Dash cũng có thể lấy tài liệu từ readthedocs.org rất dễ dàng, còn DevDocs thì không có tính năng này

  • Cái này rất tuyệt. Ước gì tôi biết đến nó sớm hơn
    Khi biết chắc mình chỉ đang tìm kết quả từ tài liệu chính thức, nó tốt hơn công cụ tìm kiếm web rất nhiều và cũng nhanh hơn nhiều. Tôi đang nghĩ đến việc tải một bản sao về để chạy cục bộ hoặc tự host

  • Tôi thích công cụ này. Tôi dùng nó hằng ngày qua gói Emacs[1], và cảm thấy quy trình làm việc mượt hơn nhiều so với các giải pháp kiểu Dash
    [1]: https://github.com/astoff/devdocs.el