Rédiger le guide utilisateur (docs/user-guide/)

Aperta
#93 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
58/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Ambito
documentation

Direzione di ricerca

Read the Playwright tests in frontend/tests/ first to follow real user journeys, then inspect frontend/src/routes/(app) to identify every page and its available features. Create the guides in docs/user-guide/ and link them from the README. Done means the guides cover all app pages, avoid development jargon, and let a new musician create a first setlist by following them.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

documentation good first issue

Objectif

Rédiger un manuel d'utilisation destiné aux utilisateurs finaux — les musiciens et les administrateurs de groupes — et non aux développeurs.

User story

En tant que musicien utilisant Setly, je veux comprendre comment gérer ma bibliothèque, créer une setlist et l'exporter en PDF pour mon concert.

Tâches

  1. Créer docs/user-guide/.
  2. Rédiger les guides, à partir des fonctionnalités réellement présentes dans frontend/src/routes/(app) :
    • Installer l'application — l'ajouter à l'écran d'accueil sur mobile (c'est une PWA), et l'usage hors-ligne.
    • Gérer son groupe — différence entre admin et membre, invitation d'un nouveau membre, appartenance à plusieurs groupes et bascule de l'un à l'autre.
    • La bibliothèque — créer des chansons (durée, tonalité, tempo, paroles, accords) et des interludes (intervenant, script, durée).
    • Construire une setlist — ajouter chansons et interludes, réordonner au drag & drop, ajouter des notes propres à une setlist, dupliquer une setlist existante.
    • Le mode Live — l'affichage lisible de loin pendant le concert.
    • L'export PDF — les différents formats disponibles et quand utiliser lequel.
  3. Adopter un ton orienté utilisateur final — aucun jargon technique, pas de mention de base de données, d'API ni d'endpoint.
  4. Lier depuis le README.

Critères d'acceptation

  • Les guides couvrent l'ensemble des pages de frontend/src/routes/(app)
  • Aucun terme technique de développement n'apparaît
  • Un musicien qui découvre l'application peut créer sa première setlist en suivant le guide
  • Le README pointe vers le guide

Pour commencer

Le dossier frontend/tests/ contient les tests Playwright, qui décrivent les parcours utilisateurs réels pas à pas. C'est la meilleure source pour ne rien oublier et pour vérifier ce que l'application fait vraiment.

Lingua principale
Python
Stelle
2
Fork
0
Merge medio
21m
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Doud75/Setly

Tutte le issue di Doud75/Setly

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.