🤖

新鋭の AI ドキュメントサービス Quod AI

2 min read

はじめに

今フォローしている OSS のドキュメントが物足りず、
実装する際、github に検索をかけて、細かいところまで code reading から関数の利用を決める経験を持っているそこのあなた!!!

一度 Quod AI を試してみてはいかがでしょうか?

Quod AI Beta

2021/05/23 時点の対応言語

js, java, ruby, python, ts, php, c#

Quod AI で何ができる?

実は私も昨夜、始めて存在を知り、試しているところ。
わかったことを軽く紹介する。

一つ注意すべきなのは、サービスは現在、1 アカウントにつき、public repo を追加できるのは1つに限定しているため、厳選した方が良い。(削除機能も見つからず、選んだ以上変更できないと考えた方がいい。)

私は何も考えずに試していたので、以下リポジトリになった。

これからこの中身に沿って説明する。

https://beta.quod.ai/github/freeCodeCamp/devdocs

追加方法

前提に github アカウントが必要。

諸々連携設定が完了したら、
図の赤い枠で囲んだところを使って、お気に入りの Public リポジトリを追加できる。

基本の使い方

下部にガイドのタグがいくつかあって、ここは 「UI Event」 の結果を見てみる。

そして、そのうちの一つを collection に入れてみる。
(図は add を押した結果)

このように、ドキュメントっぽい collection の1タイトルになる。

実際、タイトルに入ると、このソースの主なコントリビュータを Expert として認識したり、
コメントを入れたりすることができる。(私はまだ試していない)

関連 topic も配下に並べてくれる。

chrome plugin 連携

公式では拡張機能 を用意しており、

拡張機能が入れた状態でその github の issue を見てみる。

以下のように、quod ai 上の検索ができる欄が出てきてくれる。関連の topic も予め羅列してくれる。

使用するイメージ

恥ずかしながら、全然 OSS 活動はしていないので、
利用するシナリオの想像ですが、

「quod ai」を使うと、課題から着手までのステップ数が減るではないか?と勝手に考えている。

  1. 前述の issue に興味を持ち取り組んでみる
  2. hint の fetch configuration を見てみる
  3. 2番目の結果から、どのように改修するかを考える

その他リンク

Quod AI team のgithub

quod ai 上のtutorial-react-twitter-api-login

最後に

自分もまだ知り始めたので、どこまで強力か知り尽くしていない。

この記事を読んで、
「この public repo 入れてみたら、普段の開発の検索が超スピードアップした!」みたいのがあれば、ぜひコメントでシェアしていただけると嬉しいです〜

私は public repo の制限を使ってしまったのはちょっと悔しがっている...

Discussion

ログインするとコメントできます