| title | sidebar_position |
|---|---|
TRG 1.06 - Administrator's Guide (User Assistance) |
1 |
:::caution Proposed release date: 15th of January 2024 :::
| Status | Created | Post-History |
|---|---|---|
| Draft - MISSING EXTERNAL INFORMATION | 10-Jan-2024 | Transfered from Release Acceptance Criteria into TRG |
Administrator's Guide is crucial for user assistance and operational success.
Who is the audience/adressant of the document?
docsFolder
- Admin Guide is available with the software at the same time.
- Admin Guide is correct and up to date; English is a must.
- The documentation is of appropriate maturity to be handed over to any Operations Company with global business practice intentions.
- In Markdown format. Link to the document available. Must point to the leading repository within Tractus-X.
De-central:
- MD files in Tractus-X repo.
specify Location of MD File
- Schedule an appointment with Architect to obtain approval prior to Gate review.
- Provide a link to documentation as early as possible and mark changes to the previous version (if applicable); expect optimization loops based on feedback.
User assistance ensures that, for example, administrators get all the information they need to accomplish their tasks with the software. Refer to an administration guide, which covers "install/deploy, configure the software" – as appropriate for the type of software and the information needs of the target group(s). UI text and embedded help complete the User assistance.