ba-user-guide
/ba-user-guide
Pisze instrukcję obsługi dla każdej roli: zadania, kroki z nazwami ekranów, zrzuty ekranu, FAQ i rozwiązywanie błędów.
- Autor
- TrinhVanHiep ↗
- Repozytorium
- bdt-kit ↗
- Licencja
- MIT
- Ostatnia zmiana repozytorium
- 30.10.2026
Ocena i bezpieczeństwo
- Pliki w paczce
- 1
- Skrypty
- 0
- Komentarze HTML
- 0
- Adresy URL w SKILL.md
- 0
Brak sygnałów. Repozytorium zmienione 30.10.2026, bez odwołań do wycofanych modeli i API.
MIT, otwarta: można używać i zmieniać, z zachowaniem informacji o autorze.
Co robi i kiedy
Pisze instrukcję obsługi dla każdej roli: zadania, kroki z nazwami ekranów, zrzuty ekranu, FAQ i rozwiązywanie błędów.
Oryginalny opis (EN)
Write a user guide or operation manual (hướng dẫn sử dụng / 操作マニュアル) per role — tasks, numbered steps with exact screen labels, screenshots taken from a local or test environment, notes, FAQ and error troubleshooting — in the user's template. Use when the user asks for a user guide, manual, HDSD, admin guide, onboarding document, or release notes for end users.
Jak działa
- Input
- Output
- Steps
- Rules
Podgląd SKILL.md
---
name: ba-user-guide
description: Write a user guide or operation manual (hướng dẫn sử dụng / 操作マニュアル) per role — tasks, numbered steps with exact screen labels, screenshots taken from a local or test environment, notes, FAQ and error troubleshooting — in the user's template. Use when the user asks for a user guide, manual, HDSD, admin guide, onboarding document, or release notes for end users.
---
# ba-user-guide
Template: `../bdt-flow/templates/user-guide.md` (kit default). A sample from the user or `.bdt/templates/user-guide.*` wins; produce the final file with `doc-from-template` (`build` mode for a past guide used as the model).
## Input
Audience and role (member, admin, operator), the features to cover, the environment to capture from, and the sample. Sources: scenarios from `ba-scenarios`, requirements, design, i18n files for exact labels and messages, the running app.
## Output
A guide with: purpose and audience, prerequisites (account, role, browser), a task index, one section per task (goal, where to find it as a menu path, numbered steps, screenshot after each meaningful step, result, notes and warnings), FAQ, troubleshooting (message shown → cause → what to do), glossary. Plus the screenshot files and a list of what could not be captured.
## Steps
1. **Task list from the user's view.** Group by role; order by how often the task is done. Each task starts with a verb ("Đăng ký gói", "動画を公開する").
2. **Exact labels.** Take button, menu and message text from the i18n file or the live screen; show the product-language label and, if the guide's language differs, the translation in brackets once.
3. **Screenshots.**
- Capture from a local dev server with a mock API, or a test environment the user names. Never from production with real personal data.
- Read-only by default. Flows that would create, change or delete data on a shared environment are captured on a local mock, or the user does that step.
- Use test data that looks real but is fake; no real emails, names or card numbers.
- Desktop width by default, 375px when the guide is for phone users; one screenshot per step that changes the screen; crop to the relevant area when the tool allows.
- Capture the region you need at full resolution (browser zoom on a region, scale 1). Do not crop afterwards with `sips` offsets: they are ignored and the crop lands in the middle.
- Save as `.bdt/work/<guide>/shots/NN-<task>-<step>.png` and reference them in order.
4. **Troubleshooting from real messages.** List the error messages the user can actually see for these tasks (from i18n error keys and API `error.code` handling) with cause and action.
5. **Write and export.** Fill the default template or build in the user's sample; run the checks in `doc-from-template`.
6. **Review pass.** Follow the guide step by step on the environment; every step must be reproducible as written. Note anything that differs from the current build.
## Rules
- Describe what the product does now; features not shipped are left out or marked "coming soon" only if the user says so.
- Never include passwords, tokens or real customer data in text or screenshots.
- Keep each step to one action.
Wersje
W bazie nie ma innych skilli o nazwie ba-user-guide.
Migawka bazy z 13.11.2026 · wersja paczki a589679e3ae9 (skrót SHA-256 całej paczki)
Pobrania w ostatnich 30 dniach: 0 · ranking
Zgłoś problem z tym skillem: szkodliwa treść, błędny opis albo prośba autora o usunięcie.
Podobne skille
- 10001-user-manual
Tworzy opartą na rolach, zorientowaną na zadania instrukcję obsługi wdrożonego produktu. - 90technical-writer-user-manual
Pisze instrukcję dla użytkowników produktu: strony zorientowane na zadania, kroki, zrzuty ekranu, zastrzeżenia i słowniczek. - 100user-guide-writing
Pisze przejrzyste przewodniki i tutoriale dla użytkowników końcowych: dokumenty onboardingowe, instrukcje how-to i strony FAQ z zrzutami ekranu i krokami. - 100kullanimkilavuzu
Tworzy instrukcję obsługi krok po kroku z zrzutów ekranu, wzorując się na dostarczonym przykładzie. - 90yibiao-user-manual
Tworzy i aktualizuje instrukcję obsługi narzędzia Yibiao w Markdown, robi zrzuty ekranu, pisze dziennik wersji z tagów Git i publikuje po akceptacji. - 100dev-guide-generator
Tworzy kompletny poradnik techniczny: wymagania, konfigurację środowiska, kroki, rozwiązywanie problemów i ściągę na koniec.