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

Đang mở
#93 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
58/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Ít trao đổi
Lĩnh vực
documentation

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
Python
Star
2
Fork
0
Merge trung bình
21 phút
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Doud75/Setly

Tất cả issue của Doud75/Setly

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.