Rédiger le guide utilisateur (docs/user-guide/)
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 58/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
调研方向
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 内容生成。
描述
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.
- 主要语言
- Python
- 星标
- 2
- 派生
- 0
- 平均合并
- 21 分钟
- 30 天内合并 PR
- 2
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
Doud75/Setly 的其他 Issue
-
agent-ready chore
难度 2/5 1-3 小时 新手友好度 86/100
-
backend enhancement frontend security
难度 4/5 3-5 天 新手友好度 48/100
-
agent-ready backend enhancement frontend security
难度 5/5 一周以上 新手友好度 25/100
-
agent-ready backend enhancement frontend security
难度 5/5 一周以上 新手友好度 35/100
-
agent-ready backend bug frontend security
难度 5/5 一周以上 新手友好度 35/100
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 78/100
marketcalls/openalgo#2472 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 95/100
marimo-team/marimo#11949 ·
维护者通常 1 天内回复
-
bug server-time v2
难度 2/5 1-3 小时 新手友好度 76/100
modelcontextprotocol/servers#5559 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 68/100
jxxghp/MoviePilot#7449 ·
维护者通常 1 天内回复
-
devops help wanted
难度 2/5 1-3 小时 新手友好度 72/100
guaardvark/guaardvark#421 ·
维护者通常 2 天内回复