Instruction 生成
- 作者仓库星标 0
- 作者仓库 skills-registry
Instruction Generator
Produces clear, scoped, non-contradictory instruction files that Claude loads and follows automatically.
Instructions are always-on: they apply whenever Claude processes matching files or contexts. Keep them concise. Every word in an instruction file costs context tokens on every invocation.
Quick Decision: Which instruction file?
| Need | File | Location |
|---|---|---|
| Applies to the whole workspace / all files | copilot-instructions.md or AGENTS.md |
.github/ or root |
| Applies to specific file types or folders | <name>.instructions.md |
.github/instructions/ |
| Applies to user (cross-workspace) | <name>.instructions.md |
{{VSCODE_USER_PROMPTS_FOLDER}}/ |
applyTo patterns:
"**"— matches all files"**/*.ts"— TypeScript files"src/**"— everything undersrc/"**/*.{ts,tsx}"— multiple extensions- Leave
applyToabsent for on-demand instructions (not auto-applied)
Workflow
Follow these steps in order. Mark each ✓ when done.
Step 1 — Clarify scope
Answer before writing:
- Who is this for? All team members (workspace) or just this user (user-level)?
- What files trigger it? Language, framework, folder, or all files?
- What behavior changes? Style, safety rules, prohibited patterns, or workflow steps?
Step 2 — Choose depth
| Variant | Use when | Target length |
|---|---|---|
| Concise rules | Simple preferences (naming, style, imports) | ≤ 20 lines |
| Extended rules | Fragile workflows, multi-step processes, error-prone areas | 20–60 lines |
| Reference-based | Large rule sets; use progressive disclosure | SKILL body → details.md |
If the instruction body would exceed 60 lines, split it:
- SKILL body: overview + key rules
- Separate
*.mdfile: extended rules, examples, edge cases
Step 3 — Write the instruction
---
applyTo: "<glob>"
description: "<optional: use for on-demand instructions>"
---
# <Short title>
<Context sentence: what this file covers and why>
## Rules
- <Rule 1: imperative, specific, verifiable>
- <Rule 2: imperative, specific, verifiable>
- <Rule n>
## Do not
- <Prohibited action 1>
- <Prohibited action 2>
See templates/instructions-concise.md and templates/instructions-extended.md.
To scaffold a stub from the command line:
python skills/instruction-generator/scripts/generate_instruction_stub.py \
--apply-to "**/*.ts" --title "TypeScript rules" [--variant concise|extended]
Step 4 — Rewrite vague rules
Run each rule through this test: "Can Claude determine pass/fail without judgment?"
| Vague (reject) | Specific (accept) |
|---|---|
| "Write good code" | "Prefer pure functions; avoid side effects in utility modules" |
| "Be concise" | "Keep function bodies under 40 lines; extract helpers if exceeded" |
| "Handle errors properly" | "Wrap async calls in try/catch; surface errors to the caller — never swallow" |
| "Use modern syntax" | "Use ES2022+; prefer ?. and ?? over manual null checks" |
Step 5 — Check for contradictions
- Does any rule contradict another in this file?
- Does any rule contradict existing instructions in
.github/copilot-instructions.md? - Are
applyTopatterns precise enough? (Overly broad patterns → high context cost)
Step 6 — Validate quality checklist
- Every rule is imperative and verifiable (no "should", "try to", "consider").
-
applyTopattern is correct glob syntax — validated against target file paths. - No time-sensitive information (no version numbers with expiry dates, no API phases).
- Consistent terminology throughout (same term for same concept).
- Instructions don't duplicate VS Code / Copilot defaults.
- File length is appropriate for the chosen depth variant.
Run the validator to catch soft rules and frontmatter issues automatically:
python skills/instruction-generator/scripts/validate_instruction_output.py <path>
# or via poe:
poe validate-instructions <path>
Anti-patterns
- Omnibus instructions: one file covering too many unrelated concerns. Split by domain.
- Soft rules: "prefer" without a fallback condition. Use "unless X, then Y" when needed.
- Stale specifics: "until August 2025 use the old API" — becomes wrong immediately.
- Missing
applyTo: without a glob, the file is on-demand only; teams expecting auto-apply will be confused. - Duplicating documentation: instructions should tell Claude what to do, not explain the library.
Output format
Deliver the full instruction file (frontmatter + body) and note:
- Recommended file path
- Recommended scope (workspace vs user)
- Any follow-up rule files if progressive disclosure was used
See examples/ for language-specific and workflow-specific patterns. Concise template: templates/instructions-concise.md Extended template: templates/instructions-extended.md
<!-- tomevault:4.0:skill_md:2026-05-23 -->Source: Anselmoo/universal-creator — distributed by TomeVault.
- 流狐分类
- 通用
- 作者声明 Agent
- 未找到明确声明;不据此推断已兼容或已测试
- 静态检查
- 88 / 100 · 启发式扫描,不代表运行安全
- 作者 / 版本 / 许可
- @tomevault-io · 未声明 license
- 流狐 Token 估算
- 低消耗
- 流狐接入估算
- 即装即用
- 是否需要外部 API Key
- 未发现要求
- 检测到的系统要求
- 未声明
- 底层运行要求
- Python
- 检测到的文件与系统行为
-
- 只读
- 允许写入 / 修改
- 检测到的网络行为
- 仅限本地
- 安装命令数
- 无(仅作为资料)
档案由构建时根据 SKILL.md 与安装命令自动衍生,可能与作者实际意图存在差异。
需要注意: 未限定 allowed-tools,默认拥有全部工具权限。
作者没有在当前 SKILL.md 中定义固定输出样例。 Follow these steps in order. Mark each ✓ when done.
Answer before writing: Who is this for? All team members (workspace) or just this user (user-level)? What files trigger it? Language, framework, folder, or all files?
Variant · Use when · Target length Concise rules · Simple preferences (naming, style, imports) · ≤ 20 lines Extended rules · Fragile workflows, multi-step processes, error-prone areas · 20–60 lines
Step 3 — Write the instruction
Run each rule through this test: "Can Claude determine pass/fail without judgment?" Vague (reject) · Specific (accept) "Write good code" · "Prefer pure functions; avoid side effects in utility modules"
[ ] Does any rule contradict another in this file? [ ] Does any rule contradict existing instructions in .github/copilot-instructions.md? [ ] Are applyTo patterns precise enough? (Overly broad patterns → high context cost)
# Instruction Generator
Produces clear, scoped, non-contradictory instruction files that Claude loads
and follows automatically.
Instructions are **always-on**: they apply whenever Claude processes matching
files or contexts. Keep them concise. Every word in an instruction file costs
context tokens on every invocation.
## Quick Decision: Which instruction file?
| Need | File | Location |
|------|------|----------|
| Applies to the whole workspace / all files | `copilot-instructions.md` or `AGENTS.md` | `.github/` or root |
| Applies to specific file types or folders | `<name>.instructions.md` | `.github/instructions/` |
| Applies to user (cross-workspace) | `<name>.instructions.md` | `{{VSCODE_USER_PROMPTS_FOLDER}}/` |
`applyTo` patterns:
- `"**"` — matches all files
- `"**/*.ts"` — TypeScript files
- `"src/**"` — everything under `src/`
- `"**/*.{ts,tsx}"` — multiple extensions
- Leave `applyTo` absent for on-demand instructions (not auto-applied)
## Workflow
Follow these steps in order. Mark each ✓ when done.
### Step 1 — Clarify scope
Answer before writing:
- **Who is this for?** All team members (workspace) or just this user (user-level)?
- **What files trigger it?** Language, framework, folder, or all files?
- **What behavior changes?** Style, safety rules, prohibited patterns, or workflow steps?
### Step 2 — Choose depth
| Variant | Use when | Target length |
|---------|----------|---------------|
| Concise rules | Simple preferences (naming, style, imports) | ≤ 20 lines |
| Extended rules | Fragile workflows, multi-step processes, error-prone areas | 20–60 lines |
| Reference-based | Large rule sets; use progressive disclosure | SKILL body → `details.md` |
If the instruction body would exceed 60 lines, split it:
- SKILL body: overview + key rules
… 作者原文负责流程事实;流狐只索引当前章节、要点、文件与命令。
章节 -> Quick Decision: Which instruction file? → Workflow → Step 1 — Clarify scope → Step 2 — Choose depth → Step 3 — Write the instruction → Rules
要点 -> always-on · Who is this for? · What files trigger it? · What behavior changes? · Omnibus instructions · Soft rules · Stale specifics · Missing applyTo
文件/命令 -> copilot-instructions.md · AGENTS.md · .github/ · <name>.instructions.md · .github/instructions/ · {{VSCODEUSERPROMPTSFOLDER}}/ · applyTo · "/.ts"
内容 SHA-256 -> 1b57cc5f1af4
方法与流程
适用与边界
原文中的明确线索
copilot-instructions.md、AGENTS.md、.github/、<name>.instructions.md、.github/instructions/、{{VSCODEUSERPROMPTSFOLDER}}/、applyTo、"/.ts"