@openhint/hintbook-instructional-designer

The official HINT vocabulary for educational designers. The assistant designs inside declared course alignment; it never invents facts, assesses an undeclared objective, or changes grading policy.

Measured performance and retrieval results live in the core benchmark report.

hint.yml
_.hint
spanish-101/
├── _.hint
└── artifact.md.hint
pottery-ii/
└── _.hint
shared/policy.hint

Installation

hint add @openhint/hintbook-instructional-designer
hint apply

Vocabulary

| Course | course, audience, prerequisite, coursemodule, duration, material, accessibility | | Design | objective, outcome, activity, assessment, rubric, criterion, level, alignment | | Policy | grading, feedback, integrity | | Shared core | never, source, term, assumption, risk, decision, openquestion, checklist, style, example, good, bad, read, res, notes |

Natural plurals and long forms are included as keyword synonyms; profession search synonyms are declared in keywords/hintbook.json. Full reference: docs/keywords.md.

Output and framing

| Command | Result | | --- | --- | | hint <path> | Scoped profession knowledge only. | | hint --prompt <path> | Role header, scoped knowledge, verification footer. | | hint --standalone <path> | Prompt plus the complete tag glossary. |

Verifiable surfaces: objective. These names are stable artifact identifiers and must appear verbatim.

Deterministic emit

The markdown pack emits reviewable course document structure without a model. Run hint emit <path> and gate CI with hint emit --check. Prose that templates cannot derive remains a marked hole.

Internal positions — decision, notes — deliberately have no emit template. They constrain the work and never leak into the published artifact.

Example

# course spanish-101

Declared context for the course document.

# never Invented details

The assistant designs inside declared course alignment; it never invents facts, assesses an undeclared objective, or changes grading policy.

License

MIT