Prompt – Guide Context Planner

Prompt Description

Authoring guidance prompt used to build and validate setup-guide outputs.

Execution Context

  • Topic / Scope: Guide authoring phase `guide-context-planner` that shapes setup documentation flow.
  • Upstream Inputs: Guide draft context, selected devices/software, and prerequisite environment assumptions.
  • Downstream Consumer: Guide writer/editor and quality validation stages for publication readiness.

System Usage

  • Used By: setup-guide authoring workflow
  • Trigger: when authoring stage `guide-context-planner` is executed
  • Inputs: guide context, topology assumptions, and implementation targets
  • Outputs: authoring instructions and structured guidance for guide assembly

Prompt Flow Context

flowchart LR
A[Upstream Context Package] --> B[Role Prompt: Guide Context Planner]
B --> C[Structured Output Artifact]
C --> D[Downstream Consumer]

Canonical Prompt Payload

# Context Planner Prompt (Guide Coverage Model)

You are a principal solution architect.

Given the topic and constraints below, produce a JSON coverage plan that defines what content must appear in the guide.

## Topic Context
- Topic: {{TOPIC}}
- Summary: {{SUMMARY}}
- Audience: {{AUDIENCE}}
- Environment: {{ENVIRONMENT}}
- Constraints: {{CONSTRAINTS}}

## Task
Return JSON only with this exact shape:

```json
{
  "context_requirements": [
    {
      "name": "short capability name",
      "description": "why this is required in this context",
      "evidence_patterns": ["regex-or-keyword-1", "regex-or-keyword-2"]
    }
  ]
}
```

## Rules
- Choose requirements based on context, not generic templates.
- Include only capabilities critical for successful implementation.
- Keep 5-10 requirements maximum.
- `evidence_patterns` should be practical phrases likely to appear in implementation content.
- Do not include markdown, prose, or code fences in the final answer.