microsoft/hve-core
Publicmirrored fromhttps://github.com/microsoft/hve-coreAvailable
docs/README.md
106lines · modecode
| 1 | --- |
| 2 | title: HVE Core Documentation |
| 3 | description: Documentation index for HVE Core Copilot customizations |
| 4 | author: Microsoft |
| 5 | ms.date: 2026-01-22 |
| 6 | ms.topic: overview |
| 7 | --- |
| 8 | |
| 9 | HVE Core is an enterprise-ready prompt engineering framework for GitHub Copilot. It provides 18 specialized agents, 18 reusable prompts, 17+ instruction sets, and a validation pipeline with JSON schema enforcement. The framework separates AI concerns into distinct artifact types with clear boundaries, preventing runaway behavior through constraint-based design. |
| 10 | |
| 11 | ## Audience |
| 12 | |
| 13 | | Role | Goal | Start Here | Key Resources | |
| 14 | |------------------------|-----------------------------|-----------------------------------------------------|---------------------------------| |
| 15 | | **Developers** | Use agents to ship features | [First Workflow](getting-started/first-workflow.md) | RPI agents, prompt patterns | |
| 16 | | **TPMs & Leads** | Coordinate AI-assisted work | [Why RPI?](rpi/why-rpi.md) | Methodology, team adoption | |
| 17 | | **Platform Engineers** | Maintain prompt libraries | [Build Workflows](architecture/workflows.md) | Validation pipeline, schemas | |
| 18 | | **Contributors** | Create new artifacts | [AI Artifacts](contributing/ai-artifacts-common.md) | Authoring patterns, conventions | |
| 19 | |
| 20 | ## Getting Started |
| 21 | |
| 22 | **Time to complete**: 15-30 minutes |
| 23 | |
| 24 | The Getting Started guide walks through installation, configuration, and running your first Copilot workflow. |
| 25 | |
| 26 | * [Installation Methods](getting-started/install.md) - Seven setup options from VSCode extension to submodule |
| 27 | * [MCP Configuration](getting-started/mcp-configuration.md) - Model Context Protocol server setup |
| 28 | * [First Workflow](getting-started/first-workflow.md) - End-to-end example with RPI agents |
| 29 | |
| 30 | **[Getting Started Guide →](getting-started/README.md)** |
| 31 | |
| 32 | ## RPI Methodology |
| 33 | |
| 34 | **Time to complete**: 20-40 minutes |
| 35 | |
| 36 | Research, Plan, Implement (RPI) is a structured methodology for complex AI-assisted engineering tasks. It separates concerns into three specialized agents that work together. |
| 37 | |
| 38 | * [Why RPI?](rpi/why-rpi.md) - Problem statement and design rationale |
| 39 | * [Task Researcher](rpi/task-researcher.md) - Discovery and context gathering |
| 40 | * [Task Planner](rpi/task-planner.md) - Structured task planning |
| 41 | * [Task Implementor](rpi/task-implementor.md) - Execution with tracking |
| 42 | * [Using Together](rpi/using-together.md) - Agent coordination patterns |
| 43 | |
| 44 | **[RPI Documentation →](rpi/README.md)** |
| 45 | |
| 46 | ## Prompt Engineering |
| 47 | |
| 48 | **Time to complete**: 15-25 minutes |
| 49 | |
| 50 | HVE Core provides a structured approach to building AI artifacts with protocol patterns, input variables, and maturity lifecycle management. |
| 51 | |
| 52 | * [Prompt Builder Agent](../.github/agents/prompt-builder.agent.md) - Interactive artifact creation with sandbox testing |
| 53 | * [AI Artifacts Overview](contributing/ai-artifacts-common.md) - Common patterns across artifact types |
| 54 | * [Activation Context](architecture/ai-artifacts.md#activation-context) - When artifacts activate within workflows |
| 55 | |
| 56 | Key differentiators: |
| 57 | |
| 58 | | Capability | Description | |
| 59 | |-------------------------|-----------------------------------------------------------| |
| 60 | | Constraint-based design | Agents know their boundaries, preventing runaway behavior | |
| 61 | | Subagent delegation | First-class pattern for decomposing complex tasks | |
| 62 | | Maturity lifecycle | Four-stage model from experimental to deprecated | |
| 63 | | Schema validation | JSON schema enforcement for all artifact types | |
| 64 | |
| 65 | ## Contributing |
| 66 | |
| 67 | **Time to complete**: 10-20 minutes |
| 68 | |
| 69 | Learn how to create and maintain AI artifacts including agents, prompts, instructions, and skills. |
| 70 | |
| 71 | * [Instructions](contributing/instructions.md) - Passive reference guidance |
| 72 | * [Prompts](contributing/prompts.md) - Task-specific procedures |
| 73 | * [Agents](contributing/custom-agents.md) - Custom personas and modes |
| 74 | * [Skills](contributing/skills.md) - Executable utilities with documentation |
| 75 | |
| 76 | **[Contributing Guide →](contributing/README.md)** |
| 77 | |
| 78 | ## Architecture |
| 79 | |
| 80 | Technical documentation for system design, component relationships, and build pipelines. |
| 81 | |
| 82 | * [Component Overview](architecture/README.md) - System components and interactions |
| 83 | * [AI Artifacts](architecture/ai-artifacts.md) - Four-tier artifact delegation model |
| 84 | * [Build Workflows](architecture/workflows.md) - GitHub Actions CI/CD architecture |
| 85 | * [Testing](architecture/testing.md) - PowerShell Pester test infrastructure |
| 86 | |
| 87 | **[Architecture Overview →](architecture/README.md)** |
| 88 | |
| 89 | ## Templates |
| 90 | |
| 91 | Pre-built templates for common engineering documents: |
| 92 | |
| 93 | * [ADR Template](templates/adr-template-solutions.md) - Architecture Decision Records |
| 94 | * [BRD Template](templates/brd-template.md) - Business Requirements Documents |
| 95 | * [Security Plan Template](templates/security-plan-template.md) - Security planning |
| 96 | |
| 97 | **[Browse Templates →](templates/)** |
| 98 | |
| 99 | ## Quick Links |
| 100 | |
| 101 | | Resource | Description | |
| 102 | |--------------------------------------------|------------------------------------| |
| 103 | | [CHANGELOG](../CHANGELOG.md) | Release history and version notes | |
| 104 | | [CONTRIBUTING](../CONTRIBUTING.md) | Repository contribution guidelines | |
| 105 | | [Scripts README](../scripts/README.md) | Automation script reference | |
| 106 | | [Extension README](../extension/README.md) | VS Code extension documentation | |
| 107 | |