Documentation Search Model
Summary
Search combines page text with governed metadata so readers can find information by intent, domain, artifact type, owner, status, version, and visibility.
Audience
- Business users, implementation partners, support engineers, developers, architects, and search maintainers
Reference Content
| Search intent | Primary facets and signals |
|---|---|
| Business search | Module, feature, business domain, concept, process, audience |
| Technical search | Service, bounded context, architecture, implementation status, repository |
| API search | Service, operation/contract, version, authorization context, related events |
| Database search | Owning service, bounded context, entity/data set, tenancy, version |
| Event search | Event name, producer, consumer, version, related module/service |
| Troubleshooting search | Symptom, response/status, module, service, audience, support owner |
Indexing rules
- Index title, description, headings, body, tags, keywords, module, service, bounded context, statuses, version, and relationship identifiers.
- Treat exact identifiers and error/status terms as high-value matches.
- Rank approved/published, current, directly owned pages above stale, archived, or indirect references when intent is equal.
- Preserve stable URLs when pages move.
- Exclude inaccessible content and metadata before query evaluation; do not filter only after returning results.
- Use synonyms through controlled keywords rather than duplicating content.
- Provide filters for content type, audience, module, service, implementation status, documentation status, visibility, version, and last review.
- Keep troubleshooting results distinct from conceptual explanations and reference.
The current local static index remains the portal search foundation. Enterprise facets and access-aware indexing are future implementation work governed by this model.
Related Articles
See Also
Keywords
- Search facets
- Query intent
- Visibility-aware indexing
Revision Information
- Status: Draft
- Last reviewed: 2026-07-15
- Review cycle: Quarterly