Agent skill
smith-placeholder
Placeholder syntax standards for documentation and prompts. Use when writing prompts, documentation, pattern descriptions, or any content with user-substitutable values.
Install this agent skill to your Project
npx add-skill https://github.com/tianjianjiang/smith/tree/main/smith-placeholder
SKILL.md
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.
Recommended Syntax
Inline Markdown (primary):
- Backticks:
placeholder_name,PLACEHOLDER_NAME - Renders as monospace, visually distinct
Inside code blocks (when backticks nest):
- Brackets:
[placeholder] - Or language-native:
PLACEHOLDERas 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:
- Use backticks for inline markdown:
placeholder_name - Use brackets inside code blocks:
[placeholder] - Avoid Jinja2
{{}}, f-string{}, and XML<>syntax
@smith-xml/SKILL.md- XML tag standards@smith-style/SKILL.md- File/branch naming patterns
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
tianjianjiang/smith
smith-style
File naming, path standards, and conventional commits. Use when naming files, creating branches, writing commit messages, or setting up new projects. Covers underscore vs hyphen conventions, commit format, and branch naming patterns.
tianjianjiang/smith
smith-stacks
Stacked pull request workflows for large features. Use when creating stacked PRs, managing dependent PRs, or rebasing after parent merges. Covers stack creation, merge order, and squash merge handling.
tianjianjiang/smith
smith-python
Python development with uv, pytest, ruff, and type hints. Use when writing Python code, running tests, managing Python packages, or working with virtual environments. Covers import organization, type hints, pytest patterns, and environment variables.
tianjianjiang/smith
smith-principles
Fundamental coding principles (DRY, KISS, YAGNI, SOLID, HHH). Use when starting any development task, evaluating implementation approaches, or reviewing code quality. Always active as foundation for all development decisions.
tianjianjiang/smith
smith-nuxt
Nuxt 3 development patterns including auto-import stubbing for tests, environment variable conventions, and middleware testing. Use when working with Nuxt projects, testing Nuxt components/middleware, or configuring Nuxt environment variables.
tianjianjiang/smith
smith-plan
Plan tracking protocol (portable). Progress tracking with checkboxes, iteration workflow, completion/blocker signals. Use when executing multi-step plans, tracking task progress, or working from plan files. IMPORTANT - Always update the plan file after completing tasks.
Didn't find tool you were looking for?