Skip to main content
Version: 0.1 (Requirements gathering)

Future Releases (v2.0+)

Future releases (including v2.0 and beyond) expand UDE's ecosystem into AI-powered docstring enrichment, quality gates and documentation coverage audits, multi-language localization workflows, professional translator integrations, and direct AST-level source parsing.

Scope of Future Releases (v2.0+)

Quality Gate & Documentation Coverage Audits

  • Documentation Coverage CLI: Adding a standalone subcommand (e.g., ude coverage) to audit API documentation coverage and output reports in CLI, Markdown, and JSON.
  • Gate Exclusions: Automatically excluding overridden methods and trivial property getters/setters (such as C# auto-properties) from coverage math.
  • Completeness Criteria: Requiring both a prose description and descriptions for all parameters and return values to consider an entity fully documented.
  • Server-Side Push-Gate Modes: Implementing the --push-gate-mode flag inside CI/CD with policies including:
    • reject: Blocking integrations if coverage falls below configured thresholds.
    • allow: Emitting warning logs without blocking integration.

Context-Rich AI-Powered Docstring Enrichment

  • Context Extraction: Analyzing both the signature and full implementation body (definition) of undocumented methods to feed context to the LLM.
  • Automated Enrichment: Implementing ude-enrich / ude document subcommands to request English docstrings from secure LLMs and safely write them back to source files in a hands-free manner.
  • Interactive AI Workflows: Supporting verify-document mode to generate pull request change proposals or suggestion structures for developer approval.

Zero-Effort Multi-Language Localization

  • Asynchronous AI Translation: Translating English docstrings and prose blocks using secure LLMs strictly upon merges to the master branch.
  • Incremental Cache: Utilizing a localized database cache so identical strings are never translated twice.
  • Translation Lifecycle Status: Tagging cache records as draft (default) or verified (manually reviewed or imported).
  • Developer Unblocking: Rendering draft translations with warning banners, or falling back to English to avoid blocking developer commits.
  • XLIFF Integrations: Providing CLI commands to export and import standard translation packets (.xlf) to professional translation services.

RAG-Structured Semantic Export

  • Hierarchical RAG Export: Exporting a semantic, highly structured JSON dataset (--format json_rag) in a single JSON file.
  • Granular Metadata: Enriching the export with entity types, fully qualified names, exact code line ranges, deterministic signature hashes, and code-dependency references for vector database ingestion and advanced Graph-RAG architectures.

Native AST Source Parsers

  • Pluggable Direct Frontends: Implementing standalone parsers utilizing tree-sitter and libclang AST to directly analyze source directories.
  • Direct Parsing Extensibility: Parsing source code directly for C++, C#, Java, and Python, removing the mandatory Doxygen dependency.

Performance & Compression

  • Translation Cache Compression: Storing translation databases as .json.gz Gzip-compressed archives to minimize repository size.
  • Pydantic Validation for Cache: Leveraging Pydantic v2 to validate translation cache and localization schema files.

Deferred Requirements (v2.0+)

Requirement IDTypeDescription
REQ-BUS-01BusinessCustom native parser frontends (direct code parsing)
REQ-BUS-03BusinessCompressed translation cache storage
REQ-BUS-04BusinessRAG Ingestion Format Support (Hierarchical JSON)
REQ-BUS-05BusinessPush-Gate Gating and LLM English Enrichment
REQ-BUS-06BusinessIncremental Translation Cache, XLIFF, Async review lifecycle
REQ-BUS-07BusinessToken Cost Reporting
REQ-BUS-08BusinessDocumentation Coverage & Quality Gate Separation
REQ-FUN-01FunctionalNon-Doxygen direct XML/AST parser inputs
REQ-FUN-02FunctionalNative parsers using libclang and tree-sitter
REQ-FUN-05Functional--format json_rag structured export
REQ-FUN-06FunctionalTranslation state metadata (draft/verified), async CI triggers
REQ-FUN-08FunctionalPush-gate execution modes (reject, allow, auto-document, verify-document)
REQ-FUN-09FunctionalContext-rich signature + definition LLM ingestion
REQ-FUN-10FunctionalXLIFF Export & Import CLI subcommands
REQ-FUN-11FunctionalGzip Translation Cache compression
REQ-FUN-12FunctionalStandalone Coverage Reporting Command
REQ-NFN-04Non-FunctionalPydantic v2 validation for translation caches