Fix #70: Best practice: HADS format for system prompts that work acro...#73
Open
JiwaniZakir wants to merge 1 commit intoOpenRouterTeam:mainfrom
Open
Conversation
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #70
Adds documentation for HADS (Human-AI Document Standard) as a best practice for writing portable system prompts across OpenRouter's 300+ supported models.
Changes
docs/hads-system-prompts.md(new file): Explains the problem of system prompts breaking when switching model tiers, introduces HADS tags ([SPEC],[NOTE],[BUG]), includes a concrete API authentication example showing all three tag types, and links to the HADS specification.README.md(line ~44): Adds a "Portable System Prompts (HADS)" entry under the examples index, pointing to the new doc.Motivation
System prompts that work on GPT-4 frequently degrade on smaller models (Llama 3 8B, Mistral 7B) because those models rely on structural inference rather than explicit instruction. HADS replaces implicit structure with direct semantic tags, producing consistent behavior across model tiers without any tooling — pure Markdown. This is directly relevant to OpenRouter users who switch models mid-project and need their system prompts to remain stable.
Testing
docs/hads-system-prompts.mdrenders correctly in GitHub's Markdown preview, including the fenced code block containing HADS-tagged content.[docs/hads-system-prompts.md](docs/hads-system-prompts.md)resolves correctly relative to the repo root.This PR was created with AI assistance (Claude). The changes were reviewed by quality gates and a critic model before submission.