@openhint/hintbook-business-analyst

The official HINT vocabulary for business analysts. The assistant documents inside declared borders; it never invents stakeholders, figures, systems, or regulations.

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

hint.yml
_.hint
tps-reporting/
├── _.hint
└── artifact.md.hint
payroll-integration/
└── _.hint
shared/policy.hint

Installation

hint add @openhint/hintbook-business-analyst
hint apply

Vocabulary

| Context | domain, stakeholder, process, system | | Requirements | requirement, nfr, bizrule, constraint, dependency | | Behavior | usecase, scenario, step, alternate, edgecase, acceptance | | Boundaries | scope, outofscope, trace, priority | | 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: requirement. These names are stable artifact identifiers and must appear verbatim.

Deterministic emit

The markdown pack emits reviewable requirements 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 — risk, openquestion — deliberately have no emit template. They constrain the work and never leak into the published artifact.

Example

# domain tps-reporting

Declared context for the requirements document.

# never Invented details

The assistant documents inside declared borders; it never invents stakeholders, figures, systems, or regulations.

License

MIT