Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
141 changes: 141 additions & 0 deletions formats/enhancement-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,141 @@
<!-- SPDX-License-Identifier: MIT -->
<!-- Copyright (c) PromptKit Contributors -->

---
name: enhancement-report
type: format
description: >
Output format for prompt asset enhancement. Structures asset
identification, provenance and version detection, a capability baseline, a
prioritized enhancement plan classified by the enhancement-categories
taxonomy, application status, residual gaps, and coverage.
produces: enhancement-report
---

# Format: Enhancement Report

The output MUST be a structured enhancement report. The report accompanies the
enhancement work in both modes: in **document mode** it is the sole
deliverable (a plan); in **action mode** it records what was applied to the
asset.

The report uses a **single required structure** (defined under Document
Structure below). Every section is required; do **not** omit a section. If a
section has no content, state "None identified" (or, for Applied Changes in
document mode, "Not applicable — document mode").

## Status and Priority Vocabularies

- **Enhancement status** (one per opportunity):
- **Proposed** — identified and offered; not yet acted on (document mode, or
awaiting confirmation).
- **Applied** — confirmed and written into the asset (action mode).
- **Deferred** — confirmed relevant but intentionally not applied this pass;
state why.
- **Skipped** — excluded by the user's focus, or declined; state why.
- **Priority**: High / Medium / Low, per the `enhancement-categories`
taxonomy's priority guidance. Do not invent a different scale.

## Document Structure

The report MUST include the following sections in this exact order. Sections
**1-8** are required. Do **not** omit a section; if a section has no content,
state "None identified" (or, for Applied Changes in document mode, "Not
applicable — document mode"). If there are **zero** opportunities, state "None
identified" in the Enhancement Plan and record what was examined in Coverage.

```markdown
# <Asset Name> — Enhancement Report

## 1. Executive Summary
<2-4 sentences for stakeholders: what asset was assessed, its provenance and
detected version, the count and highest priority of opportunities, and the
overall recommendation or what was applied. Understandable on its own.>

## 2. Asset Summary
- **Type**: <raw prompt / Copilot prompt file / agent definition /
instruction-skill file / mixed set>
- **Files**: <paths, or "inline content">
- **Intent**: <one or two sentences; label [KNOWN] or [INFERRED]>
- **Mode**: <document / action>
- **Focus**: <user-specified enhancement categories, or "none — full scan">

## 3. Provenance and Version Detection
- **Provenance**: <PromptKit provenance detected (version known) / PromptKit
provenance detected (version unknown) / No PromptKit provenance detected>
- **Detected version**: <version, or "unknown" / "n/a">
- **Evidence**: <the marker text or structural signals observed, with
locations; or "no PromptKit marker or structural match found">

## 4. Capability Baseline
<For each PromptKit layer, the asset's current coverage. Use a table:

| Layer | Coverage | Evidence |
|-------|----------|----------|
| Persona / identity | Full / Partial / Absent | <location or note> |
| Guardrails | Full / Partial / Absent | <location or note> |
| Analysis / reasoning | Full / Partial / Absent | <location or note> |
| Output format | Full / Partial / Absent | <location or note> |
| Taxonomy | Full / Partial / Absent | <location or note> |

List preserved user customizations below the table, or "None identified".>

## 5. Enhancement Plan
<All opportunities, ordered by priority then by the taxonomy Ranking Criteria.
Lead with a summary table, then a detail block per opportunity.

| ID | Category | Priority | Status | Summary |
|----|----------|----------|--------|---------|
| E-001 | E1_MISSING_GUARDRAIL | High | Applied | ... |

### <ID>: <Short Title>
- **Category**: <E#_LABEL>
- **Target**: <file and location>
- **Source component**: <PromptKit component or convention>
- **Change**: <concrete description; for Applied, what was written>
- **Preserves**: <user customizations protected by this change, or "n/a">
- **Priority**: High / Medium / Low
- **Status**: Proposed / Applied / Deferred / Skipped
- **Rationale**: <why this adds value; for Deferred/Skipped, why not now>

If no opportunities exist, state "None identified".>

## 6. Applied Changes
<Action mode: a per-file summary of what was changed. For each Applied
enhancement, give the file, the operation (edited / created / renamed /
deleted), and before/after notes or hunks; list any new or removed files
explicitly. Document mode: "Not applicable — document mode; no changes were
written." If action mode applied nothing (user declined or deferred all),
state "No changes applied — all opportunities remain Proposed, Deferred, or
Skipped as applicable".>

## 7. Residual Gaps and Follow-ups
<Everything discovered but not applied this pass: Deferred and Skipped
opportunities, focus-excluded categories, and low-priority forward-looking
items (e.g., E8 provenance stamp, or the library-level output-versioning
follow-up). For each: what remains and what would close it. If none, state
"None identified".>

## 8. Coverage
- **Examined**: <assets and files read, including candidate library components>
- **Method**: <how the asset was assessed and how the library was compared>
- **Excluded**: <what was not assessed, and why>
- **Limitations**: <constraints affecting confidence — e.g., inferred intent,
unknown provenance, partial access to referenced files>
```

## Formatting Rules

- Opportunities MUST be ordered by priority (High first), then by the
`enhancement-categories` Ranking Criteria.
- Every opportunity MUST carry exactly one taxonomy label and a status.
- Every opportunity that edits existing text MUST name the customizations it
preserves (or "n/a").
- Evidence MUST be concrete — cite asset locations and name source components;
do not describe changes vaguely.
- The executive summary MUST be understandable without reading the rest.
- The report MUST distinguish E2 (new capability) from E3 (version upgrade)
consistently with the provenance recorded in the Provenance and Version
Detection section — an E3 label requires PromptKit provenance evidence.
- The Coverage section MUST include all four fields — Examined, Method,
Excluded, Limitations — per the `self-verification` protocol.
43 changes: 43 additions & 0 deletions manifest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -625,6 +625,15 @@ protocols:
segments. Maps each to existing library components or marks
as novel for assimilation.

- name: prompt-enhancement
path: protocols/reasoning/prompt-enhancement.md
description: >
Reasoning protocol for enhancing an existing prompt asset with
current PromptKit capabilities. Covers ingestion, provenance and
version detection, capability baselining, gap analysis against the
library, enhancement proposal, in-place application, and
verification. Preserves original intent and user customizations.

- name: manufacturing-artifact-generation
path: protocols/reasoning/manufacturing-artifact-generation.md
description: >
Expand Down Expand Up @@ -760,6 +769,16 @@ formats:
as a scheduled or event-driven automation running in GitHub
Actions with a coding agent. Requires `gh aw` CLI for compilation.

- name: enhancement-report
path: formats/enhancement-report.md
produces: enhancement-report
description: >
Output format for prompt asset enhancement. Structures asset
identification, provenance and version detection, a capability
baseline, a prioritized enhancement plan classified by the
enhancement-categories taxonomy, application status, residual gaps,
and coverage.

- name: implementation-plan
path: formats/implementation-plan.md
produces: implementation-plan
Expand Down Expand Up @@ -945,6 +964,16 @@ taxonomies:
context hoarding, premature optimization, and ephemeral memory
failure.

- name: enhancement-categories
path: taxonomies/enhancement-categories.md
domain: prompt-asset-enhancement
description: >
Classification scheme (E1-E8) for enhancement opportunities when
upgrading an existing prompt asset with PromptKit capabilities. Covers
missing guardrails, new capabilities, version upgrades, format
modernization, determinism hardening, persona/expertise gaps,
structural decomposition, and provenance stamping.

- name: cwe-cli-tools
path: taxonomies/cwe-cli-tools.md
domain: cli-tools
Expand Down Expand Up @@ -1657,6 +1686,20 @@ templates:
persona: systems-engineer
protocols: [anti-hallucination, self-verification, session-handoff]

- name: enhance-prompt
path: templates/enhance-prompt.md
description: >
Enhance an existing prompt asset (raw prompt, Copilot prompt file,
agent definition, instruction/skill file, or a combination) with
current PromptKit capabilities. Detects PromptKit provenance,
baselines current capabilities, performs a gap analysis against the
library, and proposes prioritized, category-classified enhancements.
Supports document mode (plan) or action mode (apply in place).
persona: promptkit-contributor
protocols: [anti-hallucination, self-verification, prompt-enhancement]
taxonomies: [enhancement-categories]
format: enhancement-report

contribution:
- name: extend-library
path: templates/extend-library.md
Expand Down
Loading
Loading