Rédiger le guide utilisateur (docs/user-guide/)
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
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
- Créer
docs/user-guide/. - 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.
- Adopter un ton orienté utilisateur final — aucun jargon technique, pas de mention de base de données, d'API ni d'endpoint.
- 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
- Include un Dockerfile o un file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Doud75/Setly
-
agent-ready chore
Difficoltà 2/5 1-3 ore Idoneità per principianti 86/100
-
Connexion avec Apple (SSO)Apertabackend enhancement frontend security
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
-
agent-ready backend enhancement frontend security
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
-
agent-ready backend enhancement frontend security
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
-
agent-ready backend bug frontend security
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
Tutte le issue di Doud75/Setly
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
marketcalls/openalgo#2472 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
marimo-team/marimo#11949 ·
I maintainer di solito rispondono entro 1 giorno
-
bug server-time v2
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
modelcontextprotocol/servers#5559 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
jxxghp/MoviePilot#7449 ·
I maintainer di solito rispondono entro 1 giorno
-
devops help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
guaardvark/guaardvark#421 ·
I maintainer di solito rispondono entro 2 giorni