Skip to content

Commit a4bedca

Browse files
Fix page navigation (#1065)
* fix navigation * fix links * move usability to non-functional requirements * fix links
1 parent 6a77040 commit a4bedca

File tree

11 files changed

+8
-39
lines changed

11 files changed

+8
-39
lines changed

docs/.pages

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ nav:
33
- Engineering Fundamentals Checklist: engineering-fundamentals-checklist.md
44
- The First Week of an ISE Project: the-first-week-of-an-ise-project.md
55
- Who is ISE?: ISE.md
6+
- Contributing: contributing.md
67
- Agile Development: agile-development
78
- Automated Testing: automated-testing
89
- CI/CD: CI-CD
910
- ...
11+
- UI/UX: UI-UX

docs/CI-CD/.pages

Lines changed: 0 additions & 6 deletions
This file was deleted.
File renamed without changes.

docs/user-interface-engineering/README.md renamed to docs/UI-UX/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ Keep in mind that like all software, there is no "right way" to build a user int
1212

1313
The state of web platform engineering is fast moving. There is no one-size-fits-all solution. For any team to be successful in building a UI, they need to have an understanding of the higher-level aspects of all UI project.
1414

15-
1. [**Accessibility**](../accessibility/README.md) - ensuring your application is usable and enjoyed by as many people as possible is at the heart of accessibility and inclusive design.
16-
1. [**Usability**](./usability.md) - how effortless should it be for any given user to use the application? Do they need special training or a document to understand how to use it, or will it be intuitive?
15+
1. [**Accessibility**](../non-functional-requirements/accessibility.md) - ensuring your application is usable and enjoyed by as many people as possible is at the heart of accessibility and inclusive design.
16+
1. [**Usability**](../non-functional-requirements/usability.md) - how effortless should it be for any given user to use the application? Do they need special training or a document to understand how to use it, or will it be intuitive?
1717
1. [**Maintainability**](../non-functional-requirements/maintainability.md) - is the application just a proof of concept to showcase an idea for future work, or will it be an MVP and act as the starting point for a larger, production-ready application? Sometimes you don't need React or any other framework. Sometimes you need React, but not all the bells and whistles from create-react-app. Understanding project maintainability requirements can simplify an engagement’s tooling needs significantly and let folks iterate without headaches.
18-
1. [**Stability**](./stability.md) - what is the cost of adding a dependency? Is it actively stable/updated/maintained? If not, can you afford the tech debt (sometimes the answer can be yes!)? Could you get 90% of the way there without adding another dependency?
18+
1. **Stability** - what is the cost of adding a dependency? Is it actively stable/updated/maintained? If not, can you afford the tech debt (sometimes the answer can be yes!)? Could you get 90% of the way there without adding another dependency?
1919

2020
More information is available for each general guidance section in the corresponding pages.
2121

docs/user-interface-engineering/recommended-technologies.md renamed to docs/UI-UX/recommended-technologies.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,3 @@ npm init vite@latest my-app --template react-ts
4848
# npm 7.x
4949
npm init vite@latest my-app -- --template react-ts
5050
```
51-
52-
## HTML/CSS/JS
53-
54-
> Coming soon!
55-
56-
## Web Components
57-
58-
> Coming soon!
File renamed without changes.

docs/user-interface-engineering/usability.md renamed to docs/non-functional-requirements/usability.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Usability is a topic that is often used interchangeably with user experience (UX), but they are not the same thing. Usability is a subset of UX, focusing specifically on the ease of use and effectiveness of a product, i.e., it is the ease with which users can learn and use a product to achieve their goals. Usability is a key factor in determining the success of a product, as it directly impacts user satisfaction, productivity, and overall experience. A system that is difficult to use or understand can lead to frustration, errors, and ultimately, abandonment by users.
44

5-
Closely coupled with usability and UX is the concept of accessibility, which you can read more about [here](../accessibility/README.md).
5+
Closely coupled with usability and UX is the concept of [accessibility](./accessibility.md).
66

77
## Characteristics
88

docs/resources/ms_icon.png

-2.27 KB
Binary file not shown.

docs/resources/templates/README.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

docs/user-interface-engineering/stability.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)