smith-placeholder

Placeholder syntax standards for documentation and prompts. Use when writing prompts, documentation, pattern descriptions, or any content with user-substitutable values.

📖 中文导读:Placeholder syntax standards for documentation and prompts. Use when writing prompts, documentation, pattern descriptions, or any content with user-substitutable values. 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

name: smith-placeholder description: Placeholder syntax standards for documentation and prompts. Use when writing prompts, documentation, pattern descriptions, or any content with user-substitutable values.

Placeholder Syntax Standards

  • Scope: Placeholder syntax for documentation and prompts
  • Load if: Writing prompts, documentation, or pattern descriptions
  • Prerequisites: @smith-principles/SKILL.md, @smith-standards/SKILL.md

Placeholders indicate where users substitute values. Syntax must avoid conflicts with Jinja2, Python f-strings, and XML tags.

Code blocks within documents follow their own language conventions.

Inline Markdown (primary):

  • Backticks: placeholder_name, PLACEHOLDER_NAME
  • Renders as monospace, visually distinct

Inside code blocks (when backticks nest):

  • Brackets: [placeholder]
  • Or language-native: PLACEHOLDER as literal identifier

Avoid in documentation:

  • {{placeholder}} - Jinja2 template conflict
  • {placeholder} - Python f-string conflict
  • <placeholder> - XML tag conflict

Code Block Conventions

Code blocks follow their language's conventions:

Shell (use literal UPPER_SNAKE or quotes):

git checkout -b "feat/FEATURE_NAME"
export API_KEY="YOUR_API_KEY"
# Python: use descriptive identifiers
user_input = "..."  # Replace with actual input
// JavaScript: use string literals
const apiKey = "YOUR_API_KEY";

ACTION (Recency Zone)

When writing placeholders:

  1. Use backticks for inline markdown: placeholder_name
  2. Use brackets inside code blocks: [placeholder]
  3. Avoid Jinja2 {{}}, f-string {}, and XML <> syntax
  • @smith-xml/SKILL.md - XML tag standards
  • @smith-style/SKILL.md - File/branch naming patterns