Files

Prompt style guide for teams that keep prompts in a codebase

A drop-in style guide for production prompts: file layout and front matter, section order, wording rules, what never belongs in a prompt, how to change prompts safely, and a reviewer checklist for pull requests.

File in Engineering by AISkillHub Library

What it does

Once more than one person edits prompts, you need shared conventions for the same reasons you need them for code: so reviews are fast, changes are safe, and nobody has to guess why a strange sentence is there. This guide is short enough that people will actually read it.

**What it covers**

1. **File layout**: one prompt per file under `prompts/`, named for the job, with front matter for `name`, `description`, `variables` and `owner`. Model IDs and sampling settings stay in config, not prompt text. 2. **Structure**: role and context, tagged inputs, one task, testable rules, exact output format, optional examples. Long documents go before the instructions that use them. 3. **Wording rules**: say what to do rather than only what to avoid; give the reason for unusual rules; specify length concretely; define judgment words like "urgent"; plan for empty and off-topic input; no all-caps threats; no filler; mark untrusted text as data. 4. **What does not belong**: secrets, real personal data, instructions for other features, unexplained model-specific hacks. 5. **Changing prompts**: PR with eval results, one change at a time, add the failing input to the eval set with the fix, re-run evals before rewording after a model switch. 6. **Reviewer checklist**: seven checkboxes to paste into PR templates.

**Example rule, with the reason given**

> "Keep it under 60 words because it is shown in a mobile notification" lets the model handle edge cases you did not list, where "Be brief" does not.

**What it will not do**

It is not a tutorial on prompting techniques, and it does not depend on any one model vendor. It pairs well with a prompt linter (front matter and variable checks) and a regression eval set, but works on its own as a team agreement.

Edit freely: replace the front matter keys with whatever your loader uses, and remove sections that do not apply.

How to use it

1. Copy `docs/prompt-style-guide.md` into your repository (or your team wiki). 2. Read it with the team and adjust: front matter keys to match your prompt loader, the `prompts/` folder name, and any rules you disagree with. 3. Link it from `CONTRIBUTING.md`, `AGENTS.md` or `CLAUDE.md` so humans and coding agents both follow it when editing prompts. 4. Paste the checklist from section 6 into `.github/pull_request_template.md`, or into a separate template used for prompt changes. 5. Revisit it after each major model upgrade; some wording advice changes as models change.

Files

Save each file at the path shown, relative to your project root.

  • docs/prompt-style-guide.md4.5 KB

More files

See all
  • File· OperationsFree

    Generative AI acceptable use policy template for a small company

    A fill-in AI usage policy for companies of roughly 5 to 200 people: approved tools table, data classification for what may be pasted where, allowed and prohibited uses, review and disclosure rules, product AI features, and incident reporting.

    ChatGPTClaudeGeminiCoding agents

    ALAISkillHub Library

  • File· ProductFree

    Pre-launch checklist for shipping an LLM-powered feature

    A launch readiness checklist for LLM features covering scope, data and privacy, prompt and model config, evals, injection and tool safety, cost limits, observability, user disclosure, kill switch and post-launch review, with blockers marked.

    ChatGPTClaudeGeminiCoding agents

    ALAISkillHub Library

Get AISkillHub updates in your inbox.

New features as they ship, AI live chat improvements, and the best new listings in the catalog.

Product updates, new features, and guides. Unsubscribe any time.