Proposal: Restructuring docs.trr379.de #12

New issue

Open

opened 2026-07-02 10:50:39 +00:00 by j.goddard · 0 comments

j.goddard commented

2026-07-02 10:50:39 +00:00

Member

I would like to propose a restructuring of the TRR379 documentation to improve user navigation and findability of resources. Please let me know if you have any thoughts on the proposal below.

Goals

The main goal of this restructuring would hopefully make it easier for general consortium members to find what they need without having any technical background in the TRR infrastructure. Namely, this would establish and separate out an Advanced Usage / Administration section -- which would also add structure to address #6 -- and move general service descriptions to a Platform Guides section (that can be linked to from workflows) so that general consortium members do not unnecessarily land on "unnecessary" information on e.g. lengthy descriptions of services, setting up permissions and deployments, etc.

General idea

The approach proposed here would be to restructure the navigation to be more user-oriented and task-based. For example, if a user enters the site thinking:

I'm new > Getting Started
I want to accomplish something > How to ...
I need technical details > References
I am a maintainer/administrator > Advanced Usage/Administration
I need help > Support

Proposed sitemap

Home
├── About
│   ├── Q02 Project
│   ├── [RDM Approach](https://docs.trr379.de/goals/rdm-infrasturcture/index.html)
│   └── Principles (e.g. https://docs.trr379.de/resources/identifier-concept/index.html)
│
├── Getting Started
│   ├── Accounts & Access
│   ├── Communication (e.g. Matrix channel)
│   ├── Calendars
│   ├── Infrastructure Overview (similar to PDF infrastructure guide)
│
├── [Using TRR379](https://docs.trr379.de/howtos/index.html)
│   ├── Manage your profile (i.e. workflow to update person records in knowledge pool)
│   ├── Report publications
│   ├── Work with research data (i.e. MRI data workflows, data catalog, Neurobagel data discovery, etc.)
│   ├── Fulfill RTG requirements
│   ├── Submit DFG survey
│   └── etc...
│
├── Advanced Usage/Administration
│   ├── Permissions
│   ├── Deployments
│   ├── Website maintenance
│   ├── Service status monitoring
│   └── etc...
│
├── References
│   ├── [Platform Guides](https://docs.trr379.de/services/index.html)
│   └── Glossary
│
└── Support
    ├── Contact
    └── Report Issues

Note on maintenance of docs

During this process, I would suggest reviving and implementing an earlier idea to incorporate general documentation snippets from https://hub.psychoinformatics.de/abcd-j/documentation-snippets to reduce the amount of maintenance required to keep the docs up-to-date.

I would like to propose a restructuring of the [TRR379 documentation](https://docs.trr379.de/) to improve user navigation and findability of resources. Please let me know if you have any thoughts on the proposal below. ### Goals The main goal of this restructuring would hopefully make it easier for general consortium members to find what they need without having any technical background in the TRR infrastructure. Namely, this would establish and separate out an Advanced Usage / Administration section -- which would also add structure to address https://hub.trr379.de/q04/docs.trr379.de/issues/6 -- and move general [service descriptions](https://docs.trr379.de/services/index.html) to a Platform Guides section (that can be linked to from workflows) so that general consortium members do not unnecessarily land on "unnecessary" information on e.g. lengthy descriptions of services, setting up permissions and deployments, etc. ### General idea The approach proposed here would be to restructure the navigation to be more **user-oriented** and **task-based**. For example, if a user enters the site thinking: - *I'm new* > `Getting Started` - *I want to accomplish something* > `How to ...` - *I need technical details* > `References` - *I am a maintainer/administrator* > `Advanced Usage/Administration` - *I need help* > `Support` ### Proposed sitemap ```text Home ├── About │ ├── Q02 Project │ ├── [RDM Approach](https://docs.trr379.de/goals/rdm-infrasturcture/index.html) │ └── Principles (e.g. https://docs.trr379.de/resources/identifier-concept/index.html) │ ├── Getting Started │ ├── Accounts & Access │ ├── Communication (e.g. Matrix channel) │ ├── Calendars │ ├── Infrastructure Overview (similar to PDF infrastructure guide) │ ├── [Using TRR379](https://docs.trr379.de/howtos/index.html) │ ├── Manage your profile (i.e. workflow to update person records in knowledge pool) │ ├── Report publications │ ├── Work with research data (i.e. MRI data workflows, data catalog, Neurobagel data discovery, etc.) │ ├── Fulfill RTG requirements │ ├── Submit DFG survey │ └── etc... │ ├── Advanced Usage/Administration │ ├── Permissions │ ├── Deployments │ ├── Website maintenance │ ├── Service status monitoring │ └── etc... │ ├── References │ ├── [Platform Guides](https://docs.trr379.de/services/index.html) │ └── Glossary │ └── Support ├── Contact └── Report Issues ``` ### Note on maintenance of docs During this process, I would suggest reviving and implementing an earlier idea to incorporate general documentation snippets from https://hub.psychoinformatics.de/abcd-j/documentation-snippets to reduce the amount of maintenance required to keep the docs up-to-date.

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

q04/docs.trr379.de#12

No description provided.

Rows
Columns