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

Abierto
#93 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
58/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Tranquilo

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
2
Forks
0
Merge medio
21 min
PR fusionados (30 d)
2

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Doud75/Setly

Todos los issues de Doud75/Setly

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.