Skip to content

Improve portal document search with concrete tasks

Use three documents to check whether people find the right instructions. Review titles, search terms, access rights and current versions together.

Julia Hoffmann2 min read
Three cream document sheets with grey lines and a red-handled magnifying glass over a red line.

Good portal search takes a user from a question to the relevant document they are allowed to access. Check that journey with concrete tasks before commissioning more search features. A clearer filename helps people navigate; finding and opening the right instructions also depends on content, search data and permissions.

Define three documents and the expected results

The following portal and documents are fictional. The table defines acceptance expectations, not measured search results. The example uses the roles reader for readers and admin for project administration.

Document and file

User searches for

Clear result title

Visible to

D-11, Scan_0042.pdf

Forgot password

Reset your portal password

reader, admin

D-12, FAQ_final_v3.pdf

Download CSV

Export a report as CSV

reader, admin

D-13, service.pdf

Invite colleagues

Manage project access

admin

Each file contains the relevant instructions. The title should describe the content accurately. An authorised person must be able to move from the result to the current instructions; a similar-sounding title alone does not complete the task.

Check what is actually searchable

The search index is the data prepared for searching. Establish which fields it contains: filename, visible title, tags, language and document text may serve different purposes. Check an imported file to see whether the necessary text is actually searchable. Having a PDF does not establish that.

Add the terms people use for the same task. In the example, “Download CSV” can lead to “Export a report as CSV”. Maintain these mappings around tasks. “Export” and “Delete” must not be treated as equivalent just because both concern a word such as “report”.

Microsoft describes synonym mappings as a way to expand search queries. Suitable rules depend on the language and domain vocabulary. Also test queries that an expansion might make less relevant. A German term pair is not a tested French search rule.

Include permissions and updates in the search journey

Limit results to permitted documents before displaying them. In the example, the reader role must not discover D-13 through a result, title, preview or derived result counts. Direct access to the document also needs a permission check. Microsoft's documentation explains application-supplied security filters among other approaches; the implementation depends on your platform.

Agree when changed text, new versions and revoked rights take effect in search and caches. An up-to-date title over an outdated text index can still lead to the wrong instructions. After access is revoked, a previously stored result must no longer open or display protected content.

Run acceptance checks as complete tasks

Try the three queries with the intended roles. Record the query, role, document version, expected result and actual outcome. Open the document and check whether it explains the steps needed. Add an unsuitable search term, a check with restricted access and a repeat after changing a document or revoking access.

If a case fails, identify the cause as specifically as possible: missing indexed text, unsuitable term mapping, incorrect ranking, an outdated version or a faulty permission. This gives the development team a verifiable change rather than the general instruction to “make search better”.

Sources

Written by

  • Julia HoffmannEditor for Design and UXJulia Hoffmann is responsible for the editorial content on design and user experience at ASES. Her articles cover how websites and applications are used, user interface design and digital accessibility.

Follow ASES

Read more

All articles

Software Development with ASES

Custom software, web and mobile apps