DropComments

Visszajelzés az alkalmazásodon belül

DropComments SDK

Gyűjts visszajelzést közvetlenül a készülő alkalmazásban egy szkriptcímkével, egy szerveroldali végponttal és egy saját Visszajelzés gombbal. A csapatod közvetlenül az alkalmazásra tűzhet megjegyzést, helyezhet keretet vagy készíthet rajzot, a felhasználók pedig egy rövid űrlapon küldhetnek visszajelzést. Minden az itteni projektjeidbe érkezik, ahol te és az AI-ügynököd válaszolhattok rá.

Telepítsd az SDK-t

Ingyen elkezdheted. Az alkalmazásod kulcsa a szervereden marad.

Az alkalmazásról adott visszajelzésnek nem kellene képernyőképpel kezdődnie

Ha valaki tesztelés közben talál valamit az alkalmazásodban, képernyőképet készít, körbevágja, beilleszti egy csevegésbe, és azt írja: „az a valami felül, a második képernyőn”. Te megkeresed azt a képernyőt, és megpróbálod kitalálni, mire gondolt.

Ha a szkript benne van az alkalmazásban, közvetlenül ott mutathat rá. A megjegyzéshez az akkori képernyő képe, a megjelölt hely és a küldő adatai is megérkeznek, így te vagy egy programozó ügynök rögtön nekiláthattok a javításnak. A válasz az alkalmazásban jelenik meg.

Így működik

  1. 1

    Add hozzá az alkalmazásod

    A fiókod Alkalmazások részében add meg a nevét, a címeket, amelyeken fut, és a projekteket, ahová a visszajelzései kerülnek: például egyet a csapatodnak és egyet az ügyfeleidnek. Az alkalmazás kap egy kulcsot.

  2. 2

    Add hozzá a szkriptet

    Az alkalmazás szervere tárolja a kulcsot, és a bejelentkezett személyhez egy rövid élettartamú tokent ad az oldalnak, amely azt is jelzi, hogy az illető a csapatod tagja-e. Az oldal egyetlen szkriptcímkét tölt be, a felületet pedig a saját Visszajelzés gombod nyitja meg. Másold be a DropComments által megjelenített útmutatót az alkalmazásodat építő ügynöknek, és ő hozzáadja ezeket.

  3. 3

    Megérkeznek a visszajelzések

    A csapatod tagjai megnyomják a Visszajelzés gombot, megjelölik a helyet, és írnak; mindenki jelölőit és minden választ élőben látnak az alkalmazásban. Mindenki más egy rövid űrlapot kap. Minden visszajelzés egy Drop képernyőjeként kerül a hozzá tartozó projektbe.

Telepítsd az SDK-t

Olyan webalkalmazásokhoz, amelyeknek van szerverük, és a felhasználóik bejelentkeznek. Nem kell csomagot telepíteni: egy kulcs kell a szerveredre, egy végpont, amely tokent ad az oldalnak, egy szkriptcímke és egy saját gomb, amely megnyitja a felületet.

  1. Add hozzá az alkalmazásod a DropComments Alkalmazások részében: a nevét, a címeket, amelyeken fut (https, fejlesztés közben localhost és .test címeken http is lehet), és a projekteket, ahová a visszajelzései kerülnek. Megkapod az alkalmazás kulcsát és az egyes projektek azonosítóját.

    Add hozzá az alkalmazásod

  2. Tartsd a kulcsot a szervereden, a környezeti változók vagy a titkos adatok között:

    DROPCOMMENTS_KEY=dc_app_…

    Soha ne kerüljön oldalba, a böngészőbe eljutó kódba vagy commitba. A DropComments böngészőből nem fogadja el.

  3. Adj hozzá egy tokenvégpontot. Ez a bejelentkezett személy számára tokent kér a DropCommentstől, és változatlanul visszaadja a kapott JSON-t. Ha senki sincs bejelentkezve, 401-es választ adjon, és semmi sem jelenik meg.

    // GET /api/feedback-token
    export async function GET(request) {
      const user = await getSignedInUser(request); // your own sign-in
      if (!user) return new Response(null, {status: 401});
    
      const res = await fetch("https://dropcomments.com/api/app/token", {
        method: "POST",
        headers: {
          authorization: `Bearer ${process.env.DROPCOMMENTS_KEY}`,
          "content-type": "application/json",
        },
        body: JSON.stringify({
          project: "YOUR_PROJECT_ID",
          user: {id: user.id, name: user.name},
          team: user.isStaff, // true: pin comments on the app. false: the short form
        }),
      });
      return new Response(res.body, {status: res.status, headers: {"content-type": "application/json"}});
    }

    A példa Next.js útvonalkezelőként készült; Worker, Deno vagy Bun esetén is ugyanígy működik. Express esetén ugyanazt a státuszkódot és JSON-t küldd vissza.

  4. Töltsd be a szkriptet minden oldalon, a </body> elé:

    <script src="https://dropcomments.com/live.js" data-token-url="/api/feedback-token"></script>

    Saját gombot nem jelenít meg, így egyelőre semmi sem látszik.

  5. Adj hozzá egy saját Visszajelzés gombot, amely rejtve marad, amíg a DropComments.ready nem jelzi, hogy megérkezett a token. A csapatodnak a panelt, mindenki másnak a rövid űrlapot nyissa meg:

    <button id="feedback" hidden>Feedback</button>
    
    const button = document.getElementById("feedback");
    if (await DropComments.ready) {
      button.hidden = false;
      button.addEventListener("click", () => DropComments.open());
    }

    Tedd oda, ahol illik az alkalmazásodba: a fejlécbe, egy menübe vagy egy beállítási képernyőre. A panelt, az űrlapot és a jelölőket a szkript biztosítja.

  6. Ha az oldalaid Content-Security-Policy fejlécet küldenek, engedélyezd benne a DropComments használatát:

    script-src https://dropcomments.com;
    connect-src https://dropcomments.com wss://dropcomments.com;

Vagy bízd a programozó ügynöködre. Az alkalmazás hozzáadásakor kapsz egy útmutatót, amely már tartalmazza a kulcsodat és a projektazonosítókat. Másold be az alkalmazásodat építő ügynöknek, és ő hozzáadja a végpontot, a szkriptet és a gombot.

Referencia

A token

A szervered meghívja a POST https://dropcomments.com/api/app/token végpontot, az alkalmazás kulcsát bearer tokenként használva. A project megadása kötelező, azonosító alapján. A user a bejelentkezett személy; ha kihagyod a nevét, a panel bekéri. A team dönti el, milyen eszközöket kap. A token egy óráig érvényes, és a szkript még a lejárta előtt újat kér a végpontodtól.

{
  "project": "YOUR_PROJECT_ID",
  "user": {"id": "u_123", "name": "Sam Lee"},
  "team": true
}
// → {"token": "dct.…", "expiresAt": …, "team": true, "project": {…}}

A szkript beállításai

A data-token-url a végpontod címe, amelyet a szkript az oldal sütijeivel kér le; a válasz lehet a token JSON-ja vagy a token egyszerű szövegként. A data-ui="none" semmit sem jelenít meg, így saját űrlapot használhatsz: az összegyűjtött adatokat a DropComments.send() hívással küldheted el. Számítógépről a csapat megjegyzései a kép mellett az oldal másolatát is elküldik: a Dropban az oldal gombjával nyitható meg, görgethető, a szövege kijelölhető, és egy ügynök is elolvashatja. A data-capture="picture" csak a képet küldi el. Telefonon és táblagépen mindig csak a kép kerül elküldésre.

<script src="https://dropcomments.com/live.js"
  data-token-url="/api/feedback-token"
  data-capture="picture"></script>

JavaScript

A szkript betöltése után minden a window.DropComments objektumon érhető el. A ready jelzi, hogy megérkezett-e a token, így csak ezután jelenítsd meg a gombodat.

await DropComments.ready; // true once a token came
DropComments.open();  // the team’s panel, or everyone else’s form
DropComments.close();
await DropComments.send({text: "The total is wrong", picture: true});
await DropComments.link(); // the team’s feedback in DropComments, or null

Az alkalmazásod megjelenése

A Visszajelzés gombodat szabadon formázhatod. Állítsd be ezeket a :root elemen, és a panel, az űrlap és a jelölők is átveszik őket. A többi változó: --dc-muted, --dc-line, --dc-soft, --dc-on-accent, --dc-accent-text, --dc-pin, --dc-on-pin és --dc-button-radius.

:root {
  --dc-font: "Inter", sans-serif;
  --dc-surface: #ffffff;
  --dc-text: #111827;
  --dc-accent: #4f46e5;
  --dc-radius: 12px;
}

Az adatok védelme

A megjegyzéshez képernyőkép tartozik, így minden látszik rajta, ami a képernyőn van, a begépelt szöveg is (a jelszavak pontokként). Jelöld meg mindazt, ami soha nem hagyhatja el az alkalmazásodat: ez a képen szürke téglalapként jelenik meg, az oldal másolatából pedig kimarad. A másolat nem tartalmaz szkripteket, és a kitöltött mezőket üresen hagyja.

<div data-dc-hide>
  Card ending 4242
</div>

Amit kapsz

A csapatod tesztel egy verziót

Tűzz megjegyzést a működő alkalmazásra, keretezz be valamit, vagy rajzolj rá számítógépen vagy telefonon. Minden megjegyzéshez tartozik egy képernyőkép a megjelölt hellyel, számítógépről pedig az oldal másolata is, így elég annyit írni: „itt nem működik”.

Az alkalmazás felhasználói

Rövid űrlap egy Mutass rá lehetőséggel és a képernyő képével. Mások visszajelzéseit soha nem látják, és a képük csak akkor kerül elküldésre, ha bejelölve hagyják ezt a lehetőséget.

Bétatesztelők és ügyfelek

Jelentkeztesd be azokat, akikkel kipróbálod az alkalmazást, és döntsd el, ki számít csapattagnak. A tesztkörnyezetben futó webhelyet ellenőrző ügyfél közvetlenül azon hagyhat megjegyzéseket.

Ügynök végzi a javítást

A DropCommentshez csatlakoztatott programozó ügynök elolvassa az egyes megjegyzéseket és az oldalt, amelyen készültek, elvégzi a módosítást, és válaszol. A válasz az alkalmazásban jelenik meg.

Az alkalmazásod stílusában

A felhasználóknak szánt űrlap néhány CSS-változóból átveszi a színeidet, a betűtípusodat és a sarokkerekítéseidet, de saját űrlapot is használhatsz, amelynek adatait egyetlen hívással elküldheted.

A kulcsod nálad marad

A kulcs a szervereden van, soha nem kerül oldalba. A rendszer csak az alkalmazásod címeiről fogad visszajelzést, személyenkénti korláttal, a projekteket pedig azonosító alapján választja ki.

Egyenesen a Beérkezők közé

Minden visszajelzés feladatként érkezik a projektje Beérkezők nézetébe, készen arra, hogy valaki elvállalja.

Kérdések

Bármilyen alkalmazással működik?

Bármelyik olyan webalkalmazással, amelynek van szervere, és a felhasználói bejelentkeznek: a szerver közli a DropCommentsszel, hogy ki kicsoda. Játékokkal és más, vászonra rajzolt alkalmazásokkal is működik; a vászon tartalma képként érkezik meg.

Mit küld el egy csapattag megjegyzése?

Egy kép a képernyő akkori állapotáról, amelyen minden data-dc-hide jelölésű elem szürkén jelenik meg. Számítógépről az oldal másolata is mellé kerül (kivéve, ha a data-capture="picture" beállítást használod): a stílusokkal és képekkel együtt, szkriptek nélkül, üresen hagyott beviteli mezőkkel és a data-dc-hide jelölésű elemek kihagyásával, valamint egy képpel az adott részről. A Drop a képet mutatja, asztali gépen pedig át lehet váltani az oldalra. A képet a szkript rajzolja meg az oldal elrendezése alapján, így közel áll az eredetihez, de nem pontos másolat: a transzformációk, szűrők és a ::before vagy ::after tartalmak egyszerűsítve jelennek meg. A képernyő azt is megőrzi, hol készült: az oldal címét (a #fragment nélkül), az oldal nevét, az ablak méretét és a böngészőt.

Elkülöníthetem az ügyfelek és a csapat visszajelzéseit?

Igen. Egy alkalmazás több projektbe is küldhet visszajelzéseket, és a szervere személyenként határozza meg, melyikbe kerüljenek. Így a csapat visszajelzései az egyikbe, mindenki másé egy másikba kerülnek.

Mennyibe kerül?

Minden csomagban elérhető. Az ingyenes csomagban a visszajelzéseket gyűjtő Drop egy napig fogad hozzászólásokat, utána új indul; a Pro nyitva tartja őket.

Olvass tovább

Próbáld ki a következő fájloddal

Nagyjából tíz másodperc alatt kapsz egy linket.

Dobj be egy fájlt