Skip to content

DOCS_AUDIT.md

Latest commit

 

History

History
59 lines (46 loc) · 1.71 KB

DOCS_AUDIT.md

File metadata and controls

59 lines (46 loc) · 1.71 KB

Documentation Audit - Actual vs Claimed Features

CRITICAL ISSUES FOUND:

1. IntelliSense is INCORRECT

Claimed: "As you type, IntelliSense shows functions, keywords, variables" Reality: Extension has NO CompletionProvider. Only has:

  • Signature Help - Shows parameter hints AFTER you type FunctionName(
  • Snippets - Code structure templates (IF, LOOP, etc.)
  • NO auto-complete dropdown while typing

2. Solution Opening Process

Claimed: "Automatically detects solution when folder opened" Reality: Two-step process:

  1. Open folder → Extension scans
  2. User clicks solution name in sidebar to actually open it

WHAT THE EXTENSION ACTUALLY HAS:

Navigation (F12/Ctrl+F12) - ✅ CORRECT

  • Go to Definition
  • Go to Implementation
  • Hover tooltips
  • All scope-aware, cross-file

Signature Help - ✅ EXISTS (but called "IntelliSense" incorrectly)

  • Parameter hints for built-in functions (148 functions)
  • Shows AFTER typing FunctionName(
  • Method overload support
  • NOT a completion provider

Snippets - ✅ CORRECT

  • 50+ code snippets
  • Variable declaration shortcuts
  • Structure templates

Diagnostics - ✅ CORRECT

  • Real-time error detection
  • Structure validation
  • Unreachable code detection

Build Integration - ✅ CORRECT

  • Generate applications
  • Build configurations
  • Live output

Code Editing Tools - ✅ CORRECT

  • Paste as Clarion String
  • Add Method Implementation
  • Create New Class

FIXES NEEDED:

  1. Replace "IntelliSense" with "Signature Help" throughout docs
  2. Add separate "Snippets" section
  3. Clarify NO auto-complete dropdown exists
  4. Fix solution opening instructions (already done)
  5. Remove any claims about "as you type suggestions"