DevDocs 技術ドキュメント化プラットフォーム

 (devdocs.io)
3 ポイント 投稿者 GN⁺ 2024-01-14 | 1件のコメント | WhatsAppで共有

DevDocs の紹介

  • DevDocs は、さまざまな API ドキュメントを高速で体系的かつ検索可能なインターフェースに統合したウェブサイト。
  • ユーザーは設定を通じてより多くのドキュメントを有効化し、UI をカスタマイズできる。
  • マウスを使わなくても、キーボードショートカットでサイトを効率的に利用できる。

検索機能

  • 検索はファジーマッチングに対応しており、たとえば "bgcp" と入力すると "background-clip" が表示される。
  • 特定のドキュメントを検索するには、ドキュメント名または略語を入力してから Tab キーを押せばよい。
  • ユーザーのブラウザのアドレスバーを使って検索する方法も学べる。

追加情報

  • DevDocs はオフラインでも動作し、モバイルでも利用可能で、ウェブアプリとしてインストールできる。
  • 最新情報を得るには、@DevDocs をフォローできる。
  • DevDocs は無料で、オープンソースとして提供されている。
  • コーディングを初めて学ぶ人には、freeCodeCamp のオープンソースカリキュラムを確認することを勧めている。

GN⁺の意見

  • DevDocs は開発者にとって必須のツールであり、さまざまなプログラミング言語やフレームワークのドキュメントを1か所で簡単に見つけられるようにしてくれる。
  • キーボードショートカットとファジーマッチング検索機能は、開発者の効率を高める重要な機能。
  • オフラインアクセスとモバイル互換性により、ユーザーはどこからでも情報にアクセスでき、DevDocs はさらに便利になっている。

関連記事

1件のコメント

 
GN⁺ 2024-01-14
Hacker Newsの意見

  • メンテナーの1人の意見:

    • 新しいリリースに対するドキュメント更新は、ドキュメントシステムやデザインが書き直されない限り簡単。
    • 一部のプロジェクトは定期的にドキュメントシステムを変更する。
    • ドキュメントジェネレーターがランダムなクラス名を生成し、ドキュメントの整理を煩雑にする。
    • 毎月、古くなったドキュメントの一覧を自動生成しており、助けが必要。

  • オフラインドキュメントに関するブログ記事を再訪したユーザーの意見:

    • オフラインでドキュメントを利用しやすくする技術があるのか気になっている。
    • 標準化された形式があるのか、まだ自分が知らないものがあるのかと尋ねている。

  • 長距離旅行前にチェックリストを確認するユーザーの意見:

    • オフラインで言語やAPIドキュメントに簡単にアクセスできるツールを共有している。
    • ZigとVulkanを使った開発を計画中。

  • 移動中のプログラミングで有用だと感じたユーザーの意見:

    • WiFiが不安定なときに特に便利。
    • ドキュメントを統合して単一の標準インターフェースにすれば、生産性は大きく向上するはず。

  • プログラマーの基本的なニーズが体系的に満たされていないことに驚いたユーザーの意見:

    • devdocsには定期的に使うライブラリが含まれていない。
    • Dashを使ってみたが、openaiのドキュメントを直接取得できなかった。

  • 14時間のフライト中にこのツールを使って生産的な1日にしたユーザーの意見:

    • 気が散ることなく、ドキュメントが質問に答えてくれるので非常に有用。

  • オフラインCLIツール dedoc に関するユーザーの意見:

    • ブラウザへのコンテキストスイッチを避け、CLIでdevdocsをダウンロード、検索、閲覧できる。
    • Rustで静的コンパイルされており、バイナリをダウンロードしてインストールできる。

  • オープンソースのDashのようなツールに関するユーザーの意見:

    • とても良い。

  • このツールへの感謝の意見:

    • 公式ドキュメントだけから結果を探すとき、Web検索エンジンよりはるかに優れている。
    • ローカルでコピーして実行するか、ホスティングする予定。

  • このツールを毎日Emacsパッケージ経由で使っているユーザーの意見:

    • Dashのようなソリューションに比べて、ワークフローがはるかにスムーズ。