Skip to content

Commit f3c2ee4

Browse files
authored
feat: Add Information architecture heuristics document
This commit adds an IA heuristics page to our process documentation. The NGINX DocOps teams spends a lot of time engaged with IA and is increasingly involved with using heuristics to assess content.
1 parent cd32786 commit f3c2ee4

File tree

2 files changed

+123
-0
lines changed

2 files changed

+123
-0
lines changed

documentation/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ If you're interested in contributing to the [NGINX documentation website](https:
1313
## Topics
1414

1515
- [Contributing closed content](/documentation/closed-contributions.md)
16+
- [Information architecture heuristics](/documentation/ia-heuristics.md)
1617
- [Maintainers etiquette](/documentation/maintainers-etiquette.md)
1718
- [Managing content with Hugo](/documentation/writing-hugo.md)
1819
- [Proposals](/documentation/proposals/README.md)

documentation/ia-heuristics.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Information architecture heuristics
2+
3+
This document describes some of the heuristics that the NGINX DocOps team uses to examine information architecture.
4+
5+
It is intended as reference information for discussions and work management artefacts (Such as reports or issues).
6+
7+
These heuristics are an adaptation of work done by [Abby Covert](https://abbycovert.com/).
8+
9+
## Overview
10+
11+
| Name | Description |
12+
| --------------------------------| ------------------------------------------------------- |
13+
| [Accessible](#accessible) | Where and how is information being accessed? |
14+
| [Clear](#clear) | Does the user have clear and essential information? |
15+
| [Communicative](#communicative) | Can the user anticipate content based on the structure? |
16+
| [Controllable](#controllable) | Does the user retain agency throughout a process? |
17+
| [Credible](#credible) | Can the user trust the information? |
18+
| [Delightful](#delightful) | Does the user experience feel fun and easy? |
19+
| [Findable](#findable) | Is information easily discoverable for users? |
20+
| [Learnable](#learnable) | Is navigating information familiar to the user? |
21+
| [Useful](#useful) | Does the information lead to the intended result? |
22+
| [Valuable](#valuable) | Is the information provided valuable, and how? |
23+
24+
## Accessible
25+
26+
- Is the information accessible through the most common mediums and devices?
27+
- How does the information behave when perceived through other means?
28+
- Does the information match or exceed any compliance guidelines?
29+
30+
_Accessible_ concerns how navigable the information is by users. A user should be able to traverse content using any input method, browser or device desired.
31+
32+
If critical details are not available to a user based on the method they use to access information, it is not accessible.
33+
34+
## Clear
35+
36+
- Is the information easy to understand and explain?
37+
- How does the structure reduce noise for the user journey?
38+
- Does the structure fulfil the expectations of the user persona?
39+
40+
_Clear_ concerns whether or not the information aligns with the user's background and if it is devoid of distractions.
41+
42+
The structure should streamline the user experience for navigating and reading information, allowing them to understand intent without ambiguity.
43+
44+
## Communicative
45+
46+
- Is the structure effective in recognising the user's state?
47+
- Are the structure and information consistent?
48+
- How does the structure support the information being shared?
49+
50+
_Communicative_ concerns the effectiveness of the user journey.
51+
52+
A user should be able to make informed decisions about their actions in a timely manner, and able to orient themselves within the structure.
53+
54+
## Controllable
55+
56+
- Is the process state clear for a task from the information?
57+
- Can the user anticipate errors or mistakes?
58+
- Are important controls clearly marked?
59+
60+
_Controllable_ concerns where information leads a user and how that affects them. They should be aware of the consequences when following instructions.
61+
62+
If a document leaves a user in an inoperable state, it is not controllable. This could be caused by incomplete information, or information split across multiple places reliant on context to finish a task.
63+
64+
## Credible
65+
66+
- Is the tone and focus of the information consistent?
67+
- Can the user trust the accuracy of the information?
68+
- When and how is information updated?
69+
70+
_Credible_ concerns trust in the information provided. If the tone or presentation of information is unclear, it may build uncertainty for a user.
71+
72+
The credibility of information can be considered based on where it exists in overall structure, and indicators of how recently it was updated.
73+
74+
## Delightful
75+
76+
- Does the structure make a task feel easy?
77+
- Is supporting information provided where useful?
78+
- How does the information exceed expectation?
79+
80+
_Delightful_ is the step beyond fulfilling basic expectations.
81+
82+
This concerns overall quality of the user experience, such as smooth transitions between mediums and useful recommendations.
83+
84+
## Findable
85+
86+
- Is it easy for users to locate information?
87+
- What methods are available for users to discover information?
88+
- Does the information translate effectively for non-human users?
89+
90+
_Findable_ concerns how a user discovers and traverses your collection of information.
91+
92+
This can reflect the navigation tree or sitemap of a website, as well as contextual links between information. It is also related to how the information is percieved through search mechanisms.
93+
94+
## Learnable
95+
96+
- Is the structure clear and easy to understand?
97+
- Is the structure memorable?
98+
- How does the structure help someone understand the information?
99+
100+
_Learnable_ concerns whether or not the structure makes sense to a user, and how it shapes their mental model of information.
101+
102+
This can be examined from multiple angles, such as if the structure is consistent across products, or if it matches their journey.
103+
104+
## Useful
105+
106+
- Is the information correct?
107+
- Is the information complete?
108+
- Does the information serve both existing and new users?
109+
110+
_Useful_ concerns the baseline for the user experience by enabling them to complete tasks.
111+
112+
Information is useful if it accomodates new and old users, and if it enables them to concisely navigate through context with confidence.
113+
114+
## Valuable
115+
116+
- Is the information desireable to the user?
117+
- Does it fulfill expectations across all channels?
118+
- How is success quantified?
119+
120+
_Valuable_ concerns if the information is desireable, and if the story presented compelling to the user.
121+
122+
This can be emphasized by highlighting information that aligns with the user's mental models and the tangible benefits of a particular use case.

0 commit comments

Comments
 (0)