Skip to content

Commit 30aa25c

Browse files
committed
fixing markdown Fenced code blocks should have a language specified
1 parent bc608ad commit 30aa25c

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/annexes/annex-5/annex-5.01-design-guide.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ An additional 2 were added to address these important areas:
111111

112112
## 2 Design criteria
113113

114-
```
114+
```text
115115
Disclaimer: The design guidelines listed in this document shall not be
116116
considered as mandatory towards the implementations of the EUDI Wallet, but
117117
rather stand as recommendations to ensure a common user experience across the
@@ -124,7 +124,7 @@ corresponding design criteria.
124124

125125
### 2.1 Visibility of system status
126126

127-
```
127+
```text
128128
The design should always keep users informed about what is going on through
129129
appropriate feedback within a reasonable amount of time.
130130
```
@@ -150,7 +150,7 @@ _Figure 2: Interactive Elements example_
150150

151151
### 2.2 Match between system and the real world
152152

153-
```
153+
```text
154154
The design should speak the users' language. Use words, phrases, and concepts
155155
familiar to the user, rather than internal jargon. Follow real-world
156156
conventions, making information appear in a natural and logical order.
@@ -186,7 +186,7 @@ _Figure 5: Icons Example_
186186

187187
### 2.3 User control and freedom
188188

189-
```
189+
```text
190190
Users often perform actions by mistake. They need a clearly marked "emergency
191191
exit" to leave the unwanted action without having to go through an extended
192192
process.
@@ -208,7 +208,7 @@ _Figure 6: Undo and Redo Example_
208208

209209
### 2.4 Consistency and standards
210210

211-
```
211+
```text
212212
Users should not have to wonder whether different words, situations, or actions
213213
mean the same thing. Follow platform and industry conventions.
214214
```
@@ -223,7 +223,7 @@ E.g. Position of menu, Navigation bar, Search location
223223

224224
### 2.5 Error prevention
225225

226-
```
226+
```text
227227
Good error messages are important, but the best designs carefully prevent
228228
problems from occurring in the first place. Either eliminate error-prone
229229
conditions or check for them and present users with a confirmation option before
@@ -255,7 +255,7 @@ _Figure 8: Flexible Inputs Example_
255255

256256
### 2.6 Recognition rather than recall
257257

258-
```
258+
```text
259259
Minimize the user's memory load by making elements, actions, and options
260260
visible. The user should not have to remember information from one part of the
261261
interface to another. Information required to use the design (e.g. field labels
@@ -266,7 +266,7 @@ or menu items) should be visible or easily retrievable when needed.
266266

267267
### 2.7 Flexibility and efficiency of use
268268

269-
```
269+
```text
270270
Offer shortcuts quick ways to get one or more tasks done with your apps. They
271271
should speed up the interaction with an app for the expert user
272272
```
@@ -285,7 +285,7 @@ Users can customise their home screens with the documents most relevant for them
285285

286286
### 2.8 Aesthetic and minimalist design
287287

288-
```
288+
```text
289289
Interfaces should not contain information which is irrelevant or rarely needed.
290290
Every extra unit of information in an interface competes with the relevant units
291291
of information and diminishes their relative visibility. Use whitespace in
@@ -296,7 +296,7 @@ harmony with your content.
296296

297297
### 2.9 Help users recognize, diagnose, and recover from errors
298298

299-
```
299+
```text
300300
Error messages should be expressed in plain language (no error codes), precisely
301301
indicate the problem, and constructively suggest a solution.
302302
```
@@ -310,7 +310,7 @@ _Figure 9: Error Messages Examples_
310310

311311
### 2.10 Help and documentation
312312

313-
```
313+
```text
314314
It's best if the system doesn't need any additional explanation. However, it may
315315
be necessary to provide documentation to help users understand how to complete
316316
their tasks.
@@ -450,7 +450,7 @@ perfect tense.
450450
When a phrase describes a goal and the action needed to achieve it, start the
451451
sentence with the goal.
452452

453-
```
453+
```text
454454
To add a document, click +
455455
```
456456

@@ -459,7 +459,7 @@ To add a document, click +
459459
Start a statement with the objective ("to add a document") and end it with the
460460
user action ("click + ").
461461

462-
```
462+
```text
463463
Click + to add a document
464464
```
465465

@@ -475,7 +475,7 @@ a document").
475475
To avoid confusing the user, avoid using "me" or "my," and "you" or "your," in
476476
the same phrase.
477477

478-
```
478+
```text
479479
Change your preferences in My Account
480480
```
481481

@@ -484,7 +484,7 @@ Change your preferences in My Account
484484
Don't refer to the user in both the second person and the first person within
485485
the same phrase.
486486

487-
```
487+
```text
488488
Change your preferences in Account
489489
```
490490

0 commit comments

Comments
 (0)