マニュアルやオンラインヘルプの検索で検出されない言葉が多々ある。
Opened this issue · 2 comments
概要
前に掲示板で「F_LINECOUNT」の記述の不記載をレポートし、次回アップデートで反映される旨の回答を貰いました。
今回のアップデートでの反映を確認の為「F_LINECOUNT」で検索を掛けたところ、不検出でした。
念の為と思い、実際にFGETのページを見に行ってみると、F_LINECOUNTの記述はちゃんと追加されていました。
文中の言葉なら何でも検出すると思いきや、どうやら、関数名の検索は出来るが、引数名等はダメという、限定的検索になっているように見えます。
これでは、せっかくのマニュアルの使い出が半減してしまっていますし、不検出として下のメッセージが出て来るのは、読み手に非常に悪い印象を与えます。
検索結果
検索した文字列はどの文書にも見つかりませんでした。すべての単語が正確に記述されているか、あるいは、十分なカテゴリーが選択されているか確認してください。
再現スクリプト
No response
再現手順
No response
バージョン
1.0.0
不具合発生環境
Windows 10
承知しております
sphinxを使ってドキュメントを作成しているのですが、pythonドキュメント用の仕組みを流用しているのでかゆいところに手が届いていない状況です
また、検索結果に表示される文言などもプリセットされたものがそのまま使われています
いずれはUWSCRに最適化された構成にし、検索も含めて利便性を上げたいとは思っていますがsphinxがやや難解でありその作業が進んでおりません
あるいは別に使い勝手の良いドキュメント作成ツールがあれば乗り換えることも検討しています
もしもなにか良いツールをご存知でしたら教えていただけると助かります
私は、自作のコードで検索をしているのでお役に立てないと思いますが、ChatGPTに聞いてみたら下の答えが返ってきました。
参考まで。
You
検索が出来るオンラインマニュアルを作りたいのですが、使い易いオープンソフトのToolを教えてください。
ChatGPT
オンラインマニュアルを作成するための使いやすいオープンソースツールのいくつかを紹介しましょう。
DokuWiki: DokuWikiは、シンプルで使いやすいWikiシステムです。マークアップが簡単で、プラグインを使って機能を拡張することができます。オープンソースで無料で利用できます。
MediaWiki: Wikipediaなどで使われているMediaWikiは、強力なWikiエンジンで、オンラインマニュアルにも適しています。柔軟性が高く、多くの拡張機能が利用可能です。
BookStack: BookStackは、ドキュメントやマニュアルを整理して管理するためのオープンソースのアプリケーションです。視覚的に魅力的で、ユーザーフレンドリーなインターフェースを提供します。
GitBook: GitBookは、MarkdownやAsciiDocなどのフォーマットを使用してドキュメントを作成し、GitHubやGitLabなどのGitリポジトリにホスティングすることができます。オープンソース版とホステッド版の両方が提供されています。