HCL Software DocGenie
Enterprise documentation prompt engineering, inside Visual Studio Code.
DocGenie helps documentation, engineering, product, and quality teams build expert-level, token-optimized prompts for AI-assisted documentation generation. It combines JIRA ticket details, workspace evidence, Git context, and reusable documentation libraries to produce structured prompts with traceability, governance, and security built in.
DocGenie builds governed prompts, not final documents. Review AI-generated output before publication.
Table of contents
Why DocGenie?
High-quality technical documentation requires more than a generic prompt. DocGenie assembles the right context before generation:
- Requirements context from JIRA
- Implementation evidence from the active workspace and Git
- Reusable standards from predefined and custom documentation libraries
- Governance rules that separate facts, assumptions, and gaps
- Security controls that reduce accidental disclosure of credentials and secrets
The generated prompt can be used with ChatGPT, Claude, GitHub Copilot, or another AI model selected by your organization.
Key features
JIRA-based prompt generation
- Connect securely to an Atlassian JIRA instance
- Fetch ticket summary, description, and acceptance criteria
- Discover related implementation evidence, commits, and tests
- Preserve traceability between requirements and implementation
- Build documentation prompts directly from ticket context
Comprehensive documentation libraries
| Library |
Example outputs |
| Requirements & Product |
PRDs, functional specifications, user stories, traceability matrices |
| Technical Design & Architecture |
System architecture, technical design, database schemas |
| Quality Engineering |
Test plans, test cases, test strategies |
| Release & Change |
Release notes, deployment guides, change-impact analysis |
| API & Integration |
API references, integration guides, quick-start documentation |
Teams can also create custom libraries with their own document definitions, alongside the predefined catalog.
Intelligent workspace analysis
- Detect languages, frameworks, and package managers
- Classify source files, tests, APIs, configuration, and pipelines
- Inspect Git branch and commit context
- Discover implementation evidence associated with JIRA work
- Respect configurable exclusions and context-size limits
Expert prompt generation
- Build structured prompts using professional documentation standards
- Separate verified facts, assumptions, unresolved questions, and gaps
- Include governance requirements and traceability instructions
- Optimize context for efficient model usage
- Copy the completed prompt for use with your preferred AI assistant
Security-first design
- Store JIRA credentials with VS Code
SecretStorage
- Redact likely secrets before prompt generation
- Exclude sensitive files and directories by configurable pattern
- Avoid writing credentials to logs or generated documents
- Let teams control the files and evidence included in prompt context
User experience
DocGenie provides an integrated workspace in the VS Code Activity Bar:
- JIRA Configuration — connect, test, update, or clear JIRA credentials
- Library Manager — browse predefined libraries and manage custom libraries
- Generation Wizard — select a source, library, documents, and output options
- JIRA status — see the current connectivity state at a glance
Requirements
- Visual Studio Code 1.125.0 or later
- The built-in Git extension (
vscode.git) enabled
- A JIRA account and API token, for JIRA-based workflows only
- Access to an AI model such as ChatGPT, Claude, GitHub Copilot, or another assistant supported by your organization
JIRA is optional when using workspace-based prompt generation.
Installation
From the Visual Studio Marketplace
- Open the Extensions view in VS Code (
Ctrl+Shift+X / Cmd+Shift+X).
- Search for HCL Software DocGenie.
- Select Install.
- Open the DocGenie icon in the Activity Bar to get started.
From a .vsix file
- Download the
.vsix package provided by your organization.
- In VS Code, open the Extensions view and select Install from VSIX... from the
... menu.
- Select the downloaded file.
Quick start
Generate a prompt from JIRA
- Open DocGenie from the Activity Bar.
- Select JIRA Configuration.
- Enter your JIRA instance URL, account email, and API token.
- Select Test Connection.
- Save the configuration after the test succeeds.
- Open Generation Wizard.
- Choose JIRA Ticket as the source.
- Enter a ticket ID such as
ABC-123.
- Select a documentation library.
- Choose the documents to generate.
- Review the prompt configuration.
- Select Generate.
- Paste the resulting prompt into your preferred AI assistant.
- Review and refine the generated documentation.
Generate a prompt from the workspace
- Open a project folder in VS Code.
- Open Generation Wizard.
- Choose Workspace as the source.
- Select the scope to analyze.
- Choose a documentation library and document set.
- Review the prompt blueprint.
- Generate and copy the prompt.
JIRA configuration
| Field |
Description |
| Instance URL |
Atlassian JIRA URL, such as https://company.atlassian.net |
| Email |
Email associated with the Atlassian account |
| API Token |
Token generated from Atlassian account security settings |
The API token is stored using VS Code SecretStorage and is never written to logs, settings files, or generated documents.
Security and privacy
- API tokens are stored using VS Code
SecretStorage, never in plain settings or logs.
- Configurable patterns exclude sensitive files from workspace analysis by default.
- Likely secrets are redacted before prompt generation.
- Credentials are not intentionally written to logs or generated documents.
- Users remain responsible for reviewing selected context before sending it to an external AI service.
When using an external AI model, your organization's policies and the provider's data-handling terms apply.
Roadmap
- [x] JIRA integration with secure storage
- [x] Predefined documentation libraries
- [x] Workspace and Git analysis
- [x] Expert prompt generation with governance
- [x] Custom library manager
- [x] Webview-based generation wizard
- [ ] Quality gate engine with traceability
- [ ] Optional direct AI integration
- [ ] Export to DOCX, PDF, and HTML
- [ ] Advanced libraries for security, AI/ML, and governance
Release notes
See CHANGELOG.md for the full version history.
Support
For defects, enhancement requests, access requests, or general questions, contact the Central Engineering Team.
For any support request, fill out this form and the support team will reach out to you:
Click here
Important: Never include JIRA API tokens, passwords, credentials, confidential project content, customer data, or other sensitive information in a support request.
License
Released under the MIT License.
Powered by the Central Engineering Team — HCL Software
| |
