@xtatistix/ux-audit
v0.1.13
Published
UX audit tool with tour config export for istabot frontend
Downloads
491
Keywords
Readme
@istabot/tour-audit
UX audit aracı. Web sayfasında eleman seç, not yaz, screenshot al — sonunda Markdown, DOCX veya doğrudan tour config olarak export et.
Kurulum
npm install @istabot/tour-auditBookmarklet Kullanımı
npm run build
npm run bookmarklet # bookmark URL'ini üretir, tarayıcıya sürükleBookmark'a tıklandığında sayfada UX Audit paneli açılır. İkinci tıklamada toggle eder.
Kısayol: Alt + Shift + A
Programmatik Kullanım
import { createAuditPanel } from '@istabot/tour-audit';
const tool = createAuditPanel();
// Notları obje olarak al (backend'e POST için)
const tourConfig = tool.getTourConfig('my_tour_id');
await fetch('/api/tours', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(tourConfig),
});
// Dosya indirme
tool.export.markdown();
await tool.export.docx();
tool.export.tourJson('my_tour_id');
// Ham notlar
const notes = tool.getNotes();Tour Config Formatı
// buildTourConfig() çıktısı — ProjectRouteTourConfig ile uyumlu
{
id: "audit_tour_abc123",
steps: [
{
id: "step_1_buton_rengi_yanlis",
order: 1,
targetId: "submit-btn", // varsa element id, yoksa CSS selector
title: "Buton rengi yanlış",
content: "Buton rengi yanlış",
route: "/projects/123/reports",
advanceMode: "manual",
advanceLabel: "Devam",
_selector: "#submit-btn", // orijinal CSS selector (referans)
}
]
}targetId kuralı:
- Elementin
idattribute'u varsa →targetId = el.id - Yoksa →
targetId = CSS selector(fallback)
Export Formatları
| Format | Yöntem | İçerik |
|--------|--------|--------|
| Markdown | tool.export.markdown() | Screenshot embed, durum, kaynak link |
| DOCX | tool.export.docx() | Word belgesi, screenshot inline |
| Tour JSON | tool.export.tourJson() | ProjectRouteTourConfig formatı |
Verify (Claude Vision)
Her notta Verify butonu ile Claude API'ye before/after screenshot gönderilir, sorunun fix edilip edilmediği değerlendirilir. API key tarayıcıda saklanır, sadece api.anthropic.com'a gönderilir.
