Stories und Aufnahme

Wo du Anforderungen einreichst, Story-Entwürfe prüfst und Stories bearbeitest, und wie deine Werkzeuge Stories über die REST-API lesen.

Eine Story ist ein Tracker-Issue, das kanman spiegelt, mit Akzeptanzkriterien und einem Bereitschaftswert. Dein Tracker bleibt die Quelle für Titel und Beschreibung. Siehe Stories und Akzeptanzkriterien. Anforderungen reichst du in der App und in Slack ein, dort arbeitest du auch mit Stories.

Deine Werkzeuge lesen und erstellen Stories und starten Arbeit über die REST-API.

Eine Anforderung einreichen

  1. Öffne deinen Workspace; er öffnet sich mit der Unterhaltung mit kanman. Wähle das Team am Chip des Eingabefelds (oder drücke N, während du das Team ansiehst).
  2. Beschreibe, was du brauchst, und drücke Enter.

kanman ordnet jede Nachricht zuerst ein. Eine Arbeitsanfrage wird zu Story-Entwürfen; auf eine vage Anfrage kommen bis zu drei Rückfragen, die du in der Unterhaltung beantwortest. Fragen zum Stand beantwortet kanman direkt dort, und kurze Betriebsanweisungen („pausiere das Team“, „brich run-7f3k ab“) führt kanman aus, wenn du sie geben darfst.

Du kannst kanman auch in einem Slack-Thread eines verbundenen Kanals erwähnen; der Thread wird zu einer Aufnahme-Anfrage für das Team dieses Kanals. Siehe Entscheidungen in Slack beantworten.

Story-Entwürfe prüfen

Die Entwürfe kommen als Karte in der Unterhaltung, auf der du jeden Genehmigen oder Verwerfen kannst. Review öffnen zeigt alle Entwürfe einer Anfrage unter /<workspace>/teams/<team>/intake/<intake-slug>, wo du auch Text und Akzeptanzkriterien bearbeitest. Genehmigen lassen sich nur Stories, die bereit sind (Bereitschaftswert 100 und ohne blockierende offene Fragen); Inhaber und Admins des Workspaces können auch eine Story genehmigen, die nur noch offene Fragen aufhalten (Mit offenen Fragen freigeben, festgehalten als story_approved_open). N Stories in den Tracker schreiben legt die genehmigten in einem Schritt als Issues in deinem Tracker an und schreibt story_written ins Audit-Log.

Wie du Anforderungen schreibst, die Ready erreichen, beschreibt Anforderungen schreiben, die kanman erledigen kann.

Eine Story lesen und bearbeiten

Jede Story hat eine Seite unter /<workspace>/teams/<team>/stories/<story-schlüssel> mit Akzeptanzkriterien und ihren Runs. Mitglieder bearbeiten dort die Akzeptanzkriterien; kanman berechnet den Bereitschaftswert bei jeder Änderung neu.

Story-Schlüssel

Jede Story hat einen Schlüssel aus dem Schlüsselpräfix des Teams und einer Nummer, zum Beispiel SBX-12. Er steht auf dem Board, auf der Story-Seite und in den Titeln von Runs und Entscheidungen. Der Schlüssel des Issues in deinem Tracker (zum Beispiel #12 bei GitHub oder SBXDE-12 in Jira) kann davon abweichen.

REST-API

Die Stories eines Teams auflisten

GET /v1/teams/{team}/stories liefert die Stories des Teams, die neuesten zuerst, seitenweise. Story-Entwürfe einer Aufnahme-Anfrage, die noch niemand freigegeben hat, fehlen; mit drafts=true sind sie enthalten.

curl "https://api.kanman.ai/functions/v1/api-gateway/v1/teams/sandbox-team/stories?limit=50" --header "Authorization: Bearer $KANMAN_API_KEY"
Feld Beschreibung
id, key, title, team Die Story; team ist der Team-Slug.
column id, name und role (backlog, refining, ready, in_progress, review, done) der Spalte, in der die Story steht.
draft true für einen noch nicht freigegebenen Story-Entwurf.
readinessScore, size, complexity, classOfService Reife und Größe.
tracker platform, key und url des Issues in deinem Tracker, oder null.
createdAt, updatedAt Zeitstempel.

Eine Story lesen

GET /v1/stories/{story-key} liefert eine Story, zum Beispiel SBX-12, mit description, acceptanceCriteria und runKeys (die Runs der Story, die neuesten zuerst).

Arbeit starten

Ein Token kann Arbeit für ein Team starten, im Namen der Person, die es erstellt hat. Jeder Aufruf braucht seine eigene Berechtigung; Schreiben enthält die ersten drei. Die Person hinter dem Token muss Inhaber, Admin oder Mitglied des Workspace sein: Das Token eines Betrachters erhält 403.

Methode und Pfad Was er tut Berechtigung
POST /v1/teams/{team}/stories Eine Story anlegen. Sie landet im Backlog, und kanman nimmt sie auf wie jede neue Anfrage. stories:create
POST /v1/teams/{team}/stories mit "ready": true Die Story direkt in Ready anlegen, ohne kanmans Aufnahme. stories:create und stories:ready
POST /v1/stories/{story-key}/comments Eine Story in deinem Namen kommentieren. Der Kommentar richtet sich an kanman, außer du sendest "toKanman": false. stories:comment
POST /v1/stories/{story-key}/start Eine geschriebene Story starten, wie Jetzt starten in der App. Eine Story, die du gestoppt hast, geht zuerst an kanman zurück. stories:start
POST /v1/stories/{story-key}/stop kanman hört auf, an der Story zu arbeiten, und überlässt sie dir, bis du sie wieder startest. stories:start
curl https://api.kanman.ai/functions/v1/api-gateway/v1/teams/sandbox-team/stories \
  --header "Authorization: Bearer $KANMAN_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"title":"Rechnungen als CSV exportieren","description":"Die Buchhaltung braucht monatlich eine CSV aller Rechnungen."}'
{ "key": "SBX-42", "team": "sandbox-team", "stage": "intake", "kanmanNotified": true, "url": "https://app.kanman.ai/acme/teams/sandbox-team/stories/SBX-42" }

title ist Pflicht (höchstens 200 Zeichen); description ist optional (höchstens 20.000). stage ist intake oder ready.

curl https://api.kanman.ai/functions/v1/api-gateway/v1/stories/SBX-42/comments \
  --header "Authorization: Bearer $KANMAN_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{"text":"Der Kunde hat die Spalten bestätigt: Datum, Nummer, Betrag."}'

curl -X POST https://api.kanman.ai/functions/v1/api-gateway/v1/stories/SBX-42/start \
  --header "Authorization: Bearer $KANMAN_API_KEY"

start antwortet mit 200 und state started (und waitsForSlot, wenn alle Run-Plätze belegt sind) oder already_started, und mit 409 und not_written, needs_plan oder needs_yes samt message, wenn die Story noch nicht starten kann. stop antwortet mit 409, wenn bereits eine Person die Story hält.

Den Stand einer Story liest du mit GET /v1/stories/{story-key}, den eines Runs mit GET /v1/runs/{run-key}. Die OpenAPI-Beschreibung deckt diese Endpunkte ab. Damit ein anderes System einem Team ohne Token Ereignisse meldet, nutze einen Team-Webhook.

Zuletzt aktualisiert: January 1, 0001

kanman öffnen