Skip to content

As a nabledge-6 user, I want enriched search hints so that I can find relevant knowledge by class names #52

@kiyotis

Description

@kiyotis

Situation

Current search hints focus on conceptual terms (ユニバーサルDAO, 排他制御) but lack concrete class/API names that users see in their code:

  • Missing: SqlRow, VariableCondition, TransactionManagerConnection
  • Missing: BasicBatchActionBase, DataReaderFactory, DatabaseTableQueueReader
  • Missing: BeanValidation, Pagination, SelectOption
  • Missing: Exception class names beyond OptimisticLockException (e.g., DuplicateKeyException, SqlStatementException)
  • Missing: Error situations (一意制約違反, SQL実行エラー, カラム不一致)

Pain

Users who search by class names they see in import statements or stack traces get poor search results. They must manually browse knowledge files or try different conceptual terms.

Benefit

  • Users can find relevant knowledge by searching with class names from their code
  • Users can troubleshoot errors by searching with exception names from stack traces
  • Developers can maintain more discoverable knowledge base

Success Criteria

Implementation (A1: Class/API Names)

  • Add class and method names to .index[].hints in all 17 knowledge files
  • Include commonly imported classes: SqlRow, VariableCondition, TransactionManagerConnection, etc.
  • Include batch-specific classes: BasicBatchActionBase, DataReaderFactory, etc.
  • Include validation/utility classes: BeanValidation, Pagination, SelectOption, etc.

Implementation (A2: Exception Names and Error Situations)

  • Add exception class names to error-related sections: DuplicateKeyException, SqlStatementException, DbAccessException
  • Add error situation terms: 一意制約違反, SQL実行エラー, カラム不一致

Performance Validation (minimum 10 simulation runs)

  • Test with 10+ queries using class names (e.g., "SqlRow の使い方", "DuplicateKeyException の対処")
  • Report includes: search accuracy improvement, recall rate, total execution time, phase-wise time distribution
  • All test queries return relevant knowledge sections (100% recall)
  • No regression in existing conceptual term searches
  • Execution time not significantly impacted (within 5% variance)

Documentation

  • Work notes document hint selection criteria and test results in .pr/xxxxx/notes.md
  • Update CHANGELOG.md [Unreleased] section with improved discoverability

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions