Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create an information architecture #7794

Open
Tracked by #7793
tsteenbe opened this issue Nov 2, 2023 · 1 comment
Open
Tracked by #7793

Create an information architecture #7794

tsteenbe opened this issue Nov 2, 2023 · 1 comment
Assignees
Labels
documentation About end-user documentation

Comments

@tsteenbe
Copy link
Member

tsteenbe commented Nov 2, 2023

Users have complained about the state of ORT's documentation how many features are not documented and information is hard to find. This was a topic of a workshop during the ORT community days 2023 but was on hold due to lack of people having time to work on it.

Now a larger effort has been started to improve the docs in #7793. However instead of just filling pull request here and there we should design first a better setup for ORT docs e.g. a information architecture. Information architecture (IA) focuses on organizing, structuring, and labeling content in an effective and sustainable way. The goal is to help users find information and complete tasks. To do this, you need to understand how the pieces fit together to create the larger picture, how items relate to each other within the system - quote from https://www.usability.gov/what-and-why/information-architecture.html.

@tsteenbe tsteenbe added the documentation About end-user documentation label Nov 2, 2023
@tsteenbe tsteenbe self-assigned this Nov 2, 2023
@tsteenbe
Copy link
Member Author

tsteenbe commented Nov 2, 2023

Working in Google Docs on a new Website/docs see https://docs.google.com/document/d/1ooNjCE7Hzf4R0HX27FHUKPw3WQxVIXqnv0IXUzG9fwc/edit?usp=sharing

@sschuberth sschuberth changed the title Create a information architecture Create an information architecture Jan 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation About end-user documentation
Projects
None yet
Development

No branches or pull requests

1 participant