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

オープン
#93 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
58/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
2
フォーク
0
平均マージ
21分
マージ済み PR(30日)
2

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Doud75/Setly のほかの issue

Doud75/Setly の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。