Instruction file imported from GodSpeedAI/VibesPro (
.github/instructions/prompts.instructions.md). Copyright stays with the author.
Prompt Writing Instructions
Prompt files drive deterministic workflows and should be carefully crafted. When creating a new prompt:
-
Front matter is required. Include a
descriptionthat succinctly explains the purpose of the prompt, anagentfield set to'agent', and optionaltoolsandmodelfields【40083552726396†L409-L447】. Use themetadatasection to assign a uniqueid, tags and define inputs/outputs and dependencies. -
Target a single intent. Prompts should correspond to one high‑level verb such as “create plan”, “write tests” or “prepare release”. Avoid combining disparate tasks in one prompt. Use separate prompts so that routing remains unambiguous.
-
Reference other files explicitly. When the prompt needs context from a document (e.g. PRODUCT.md or plan-template.md), link it in the body using Markdown. This ensures the orchestrator loads the file into context.
-
Constrain tool usage. Specify which tool sets the prompt may call. Only include tools that are required for the task at hand. If no external tools are needed, omit the
toolsfield. -
Write clear instructions. In the body, outline step‑by‑step guidance for the agent. Describe what information to gather, how to structure responses and when to ask the user clarifying questions. Use bullet lists or numbered lists for clarity.
-
Include a handoff or next action. If the prompt produces an artifact that needs to be reviewed or executed, instruct the agent to hand off the result to the appropriate agent or to run the validation task.
-
Keep it concise. Avoid verbose explanations; the goal is to guide the agent, not to educate the user. Additional guidelines and examples can live in skill references or docs.
By following these rules, prompts remain predictable and easy to maintain, improving the quality of generated outputs and reducing hallucination risk.