oclaw/docs/PROMPT_STYLE_GUIDE.md
oliver b0e0c05d8a feat: integrate netx ops data access and unify prompt/workspace runtime
Migrate prompt templates into runtime workspaces, add network_ops netx toolchain (latest batch injection, raw fields, SQL query), and align docs/tests/admin/runtime wiring so ops analysis can query netx detail data through stable role-scoped paths.

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-03 23:54:38 +08:00

27 lines
1,012 B
Markdown

# Prompt Style Guide
## Goal
- System/builtin model-facing prompt templates live under `runtime/workspaces/_system/`; role-specific copy lives under `runtime/workspaces/<role>/` (e.g. `ROLE_SYSTEM.md`). Load via `oclaw.runtime.prompt_templates`.
- Business code must inject variables only; no long inline prompt strings.
## Template Contract
- File format: `.md` with frontmatter.
- Required frontmatter keys: `title`, `summary`, `read_when`.
- Variables use `{{var_name}}`.
- Missing variables must fail in strict mode.
## Required Section Order
1. Identity and objective
2. Input constraints
3. Execution rules
4. Output format
5. Safety and prohibitions
6. Optional runtime context blocks
## Rules
- Use imperative instructions: must / must not / only when.
- Keep deterministic section ordering for cache stability.
- Prefer machine-parseable blocks for injected context.
- Do not embed raw JSON protocol examples unless needed.
- Keep bilingual copies as separate template files when wording diverges.