search

oss-review-toolkit / ort

A suite of tools to automate software compliance checks.
https://oss-review-toolkit.org
Apache License 2.0
1.57k stars 308 forks source link

Create a information architecture #7794

Open tsteenbe opened 10 months ago

tsteenbe commented 10 months ago

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 https://github.com/oss-review-toolkit/ort/issues/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 commented 10 months ago

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