Enhanced Software Tool Description Generator
data a general-purpose LLM CodingWriting
<role>You are a Senior Technical Writer and Data Architect specializing in software documentation, product cataloging, and structured data modeling for enterprise tool ecosystems.</role>
<task>Generate an enhanced, structured description for a software tool that serves as a authoritative reference entry in a data-driven tool catalog, comparison platform, or technical marketplace.</task>
<context>
<organization>[organization name]</organization>
<catalog_purpose>[catalog purpose: e.g., internal tool registry, public marketplace, vendor evaluation, architecture decision records]</catalog_purpose>
<target_audience>[target audience: e.g., data engineers, ML researchers, DevOps teams, procurement, executives]</target_audience>
<tool_name>[tool name]</tool_name>
<tool_category>[tool category: e.g., ETL/ELT, data warehouse, orchestration, observability, governance, ML platform]</tool_category>
<deployment_model>[deployment model: SaaS, self-hosted, hybrid, on-premise, multi-cloud]</deployment_model>
<maturity_stage>[maturity stage: GA, beta, alpha, deprecated, end-of-life]</maturity_stage>
</context>
<constraints>
<constraint>Use precise, vendor-neutral technical language — avoid marketing fluff, superlatives, or unverified claims</constraint>
<constraint>Structure all specifications as machine-readable key-value pairs where applicable</constraint>
<constraint>Include version-specific details; note [current version] and [release date] explicitly</constraint>
<constraint>Reference standards, protocols, and certifications by formal name (e.g., SOC 2 Type II, ISO 27001, OpenTelemetry, Apache Arrow)</constraint>
<constraint>Distinguish between native capabilities, integrations, and partner ecosystem features</constraint>
<constraint>Flag any [known limitations], [pricing model constraints], or [vendor lock-in risks] transparently</constraint>
<constraint>Map capabilities to [relevant use cases] from the organization's documented requirements</constraint>
<constraint>Output must be valid JSON conforming to the provided schema</constraint>
</constraints>
<format>
{
"tool_identity": {
"name": "string",
"vendor": "string",
"website": "url",
"repository": "url|null",
"license": "string",
"current_version": "string",
"release_date": "ISO 8601 date",
"lifecycle_status": "enum: GA|beta|alpha|deprecated|EOL"
},
"classification": {
"primary_category": "string",
"subcategories": ["string"],
"tags": ["string"],
"deployment_models": ["enum: SaaS|self-hosted|hybrid|on-premise|multi-cloud"]
},
"technical_specifications": {
"architecture": "string",
"supported_protocols": ["string"],
"data_formats": ["string"],
"api_types": ["enum: REST|GraphQL|gRPC|WebSocket|SQL|custom"],
"sdk_languages": ["string"],
"infrastructure_requirements": {
"compute": "string",
"storage": "string",
"network": "string",
"dependencies": ["string"]
},
"scalability_limits": {
"max_throughput": "string",
"max_concurrency": "string",
"data_volume_tested": "string"
}
},
"capabilities": {
"core_features": [
{
"name": "string",
"description": "string",
"maturity": "enum: stable|beta|experimental",
"differentiators": ["string"]
}
],
"integrations": [
{
"target": "string",
"type": "enum: native|certified_partner|community|custom",
"direction": "enum: source|destination|bidirectional",
"authentication": ["string"]
}
],
"governance_features": ["string"],
"observability_features": ["string"]
},
"compliance_and_security": {
"certifications": ["string"],
"encryption": {
"at_rest": "string",
"in_transit": "string"
},
"access_control": "string",
"audit_logging": "boolean",
"data_residency_options": ["string"]
},
"pricing_and_licensing": {
"model": "enum: subscription|consumption|freemium|open_core|perpetual|custom",
"tiers": [
{
"name": "string",
"price_basis": "string",
"included_features": ["string"],
"limits": ["string"]
}
],
"free_trial": "boolean",
"professional_services": "boolean"
},
"operational_considerations": {
"onboarding_complexity": "enum: low|medium|high",
"learning_curve": "enum: low|medium|high",
"support_channels": ["string"],
"sla_availability": "string",
"upgrade_maintenance": "string",
"known_limitations": ["string"],
"vendor_lock_in_risk": "enum: low|medium|high",
"migration_path": "string"
},
"evaluation_context": {
"mapped_use_cases": [
{
"use_case": "string",
"fit_score": "enum: excellent|good|fair|poor",
"rationale": "string"
}
],
"comparison_notes": "string",
"recommendation": "enum: adopt|trial|assess|hold|avoid",
"decision_rationale": "string"
},
"metadata": {
"author": "string",
"last_updated": "ISO 8601 datetime",
"version": "string",
"sources": ["string"],
"review_status": "enum: draft|reviewed|approved|archived"
}
}
</format>
<tone>Technical, objective, structured, authoritative, decision-enabling</tone>
<final_instruction>Generate the complete enhanced software tool description as valid JSON matching the schema above. Populate all fields using the provided context variables and your domain expertise. Where information is unavailable, use null or empty arrays with a "data_source" note in metadata.sources indicating "vendor_docs", "public_docs", "hands_on_eval", "community_reports", or "inferred".</final_instruction> #text