Prompt Engineering

Create an AI Project Profile

A reusable profile that tells AI everything constant about your project — type, stack, conventions, glossary, architecture principles, and the rules it must never guess.

Overview

A project profile is the document you wish every new AI chat already had. This setup builds one for Ledger API, a public REST platform where hundreds of integrations depend on stable response shapes. The API Platform mode contributes contract-first architecture principles; the stack (C#, ASP.NET Core, EF Core, PostgreSQL) contributes its naming and convention rules; your glossary defines postings and journals. The result is a single profile that captures the whole project identity — paste it once and reuse it everywhere.

Workflow

Pick the project mode
API Platform, SaaS, Internal Tool — the mode sets sensible architecture principles.
Add the facts only you know
Overview, conventions, glossary; the engine derives the stack-driven parts.
Reuse the profile everywhere
One document covers every conversation about the project.

Why This Works

Mode-driven architecture principles match how an API platform actually has to behave
Every section the AI needs is in one place, structured and skimmable
Completeness scoring shows exactly what the profile is still missing

Best for

Public APIs with external consumers
Projects that need a single source-of-truth doc
First-time profile creators

Not for

Describing how the AI should sound or behave — use the System Prompt Generator
A snapshot of current work state — use the Context Handoff Builder

Use cases

Public APIs with external consumers
Projects that need a single source-of-truth doc
First-time profile creators

Customize This Resource

Opens this project in Project Context Builder. Build to get the full context profile — then adjust the mode, stack, glossary, and output target.

Open in Project Context Builder

Prompt Template

# Project Context: Ledger API

> Save this at `.github/copilot-instructions.md` in your repo so Copilot Chat picks it up automatically.

## Project Overview
Ledger API is a public REST API that lets fintech partners record and query double-entry transactions. Hundreds of external integrations depend on its response shapes.

## Core Facts
- Project type: API Platform
- Primary stack: ASP.NET Core, PostgreSQL, Entity Framework Core, xUnit, C#
- This is an API platform — the public interface is a contract that consumers depend on.

## Tech Stack
- ASP.NET Core
- PostgreSQL
- Entity Framework Core
- xUnit
- C#

## Team Conventions
- Every endpoint is versioned under /v1, /v2; new fields are additive only.
- Errors return the standard problem-details shape.
- Idempotency keys are required on all write endpoints.
- Use dependency injection via the built-in container and async controllers; follow the existing layering. (ASP.NET Core)
- Use migrations for schema changes and async LINQ queries; watch for N+1 with eager/explicit loading. (Entity Framework Core)
- Use [Theory]/[InlineData] for cases; one logical assertion per test where practical. (xUnit)

## Naming Rules
- Database: snake_case for tables and columns; plural table names. (PostgreSQL)

## Architecture Principles
- The public API is a contract: breaking changes require a version bump, never a silent edit.
- Validate input at the boundary and return predictable, documented error shapes.
- Keep responses backward-compatible; add fields, don't repurpose or remove them.

## Glossary
- **Posting** — a single debit or credit line in a transaction.
- **Journal** — a balanced set of postings.
- **Idempotency key** — a client-supplied token that makes a write safe to retry.

## Always Remember
- A transaction must always balance — total debits equal total credits.
- This profile is the source of truth for project facts — prefer it over general assumptions.

## Never Assume
- Do not remove or repurpose a response field — consumers depend on it.
- Do not assume the schema — reference the migrations or schema file before writing a query.
- Do not change a public endpoint's shape without treating it as a breaking change.
- Do not assume a consumer tolerates extra latency or new required fields — they are part of the contract.
- When a fact is missing from this profile, ask — do not invent it.

## AI Usage Notes
- Copilot reads repo instructions for everyone working in the codebase — commit this file so the context is shared.
- This profile is project KNOWLEDGE, not behavior — for a task persona (role, tone, escalation rules), build a System Prompt in the System Prompt Generator.
- It is durable project identity, not work state — to continue an in-progress task in a new chat, use the Context Handoff Builder.
- Profile completeness: 100/100 (Complete) — bracketed gaps, if any, mark missing info that was never invented.

Related Resources

Explore more resources that work well with this one.