Houd je helpcentrum up-to-date wanneer je een release uitbrengt

Houd mijn helpcentrum up-to-date wanneer we een release uitbrengen is het Autopilot-recept dat één helpcentrum in lijn houdt met jouw product. Het houdt in de gaten waar je wijzigingen verschijnen: releases of samengevoegde wijzigingen van een repository, een changelog-pagina of één wijziging die je beschrijft. Elke keer als er iets verandert, leest Clevera de betreffende video's en artikelen van het helpcentrum, bepaalt wat er nodig is en plant de correcties. Er verandert niets totdat je het plan goedkeurt.

Gebruik Update mijn video's wanneer het product verandert als je video's actueel wilt houden zonder helpcentrum.

Voordat je begint#

• Een helpcentrum. Zonder helpcentrum zegt de agent: "Hiervoor is eerst een helpcentrum nodig." en de kaart toont: "Dit werkt op een helpcentrum, en deze werkruimte heeft er nog geen. Bouw er eerst een en stel dit daarna in." met Bouw mijn helpcentrum, waarmee dat recept in dezelfde chat wordt geopend. Zie Bouw een helpcentrum vanuit jouw app.
• Jouw rol. Je hebt een rol nodig die inhoud kan maken. Om video's bij te werken moet je ook toestemming hebben om video's te bewerken; om artikelen bij te werken, moet je de pagina's van het helpcentrum kunnen bewerken.
• Een repository, om releases te volgen. Een eigenaar of beheerder verbindt eerst GitHub en staat de repository toe onder Autopilot → Verbindingen. Zie Verbind een repository. Voor een changelog-pagina of een wijziging die je beschrijft is geen verbinding nodig.
• Het adres van jouw app en inloggegevens, om gewijzigde schermen opnieuw op te nemen (optioneel). Zie Sla inloggegevens voor een app op.

Instellen#

1. Open het recept#

   Klik in Autopilot op Houd mijn helpcentrum up-to-date wanneer we een release uitbrengen onder Of start met een recept, of vraag erom in Wat moet Autopilot doen?, bijvoorbeeld "Update het helpcentrum elke keer als we een release uitbrengen". Het agent-paneel opent met de instellingskaart en een samenvatting van wat er is ingevuld: Wanneer, Helpcentrum, Controleren en Bekijken.

   

2. Vul de details in#

   Klik op Vul de details in (of Bewerk details wanneer alles wat nodig is, is ingevuld). Kies wanneer het wordt uitgevoerd, het helpcentrum en wat er in de gaten moet worden gehouden, en beslis of Clevera jouw app mag gebruiken. Zie Het instellingsformulier. Klik op Doorgaan.

   

3. Controleer het overzicht en maak de taak aan#

   Het overzicht toont Wanneer ("Na elke release", "Na elke samengevoegde wijziging", "Controleert de pagina elke dag", "Controleert de pagina elke week" of "Voert nu eenmaal uit"), Goedkeuring ("Elke uitvoering wacht op jouw beoordeling"), Typische uitvoering ("10–150 credits") en Taal (op naam, bijvoorbeeld "Engels (VS)"). Klik op Taak aanmaken.

4. Wacht op de eerste wijziging#

   Een taak die iets in de gaten houdt, wordt niet direct uitgevoerd. Deze staat op Actief en Nog geen uitvoeringen: "Er is niets gebeurd sinds de instelling. De eerste uitvoering wordt gepland zodra er iets gebeurt." Op de Autopilot-startpagina staat deze onder Altijd aan met een Bekijken-badge. Bij Eén keer, nu plant Clevera de correcties direct.

   

Het instellingsformulier#

Er is geen budget en geen keuze voor goedkeuring: elke uitvoering van deze taak wacht op jouw beoordeling.

Hoe vaak er wordt gecontroleerd#

Clevera leest alleen release-opmerkingen en titels en tekst van pull requests, nooit je code. Terwijl een uitvoering op jou wacht of wordt uitgevoerd, starten nieuwe wijzigingen geen tweede uitvoering: de volgende uitvoering dekt ze allemaal. Als een plan op jou wacht terwijl er meer wijzigingen binnenkomen, zegt de herinnering dat, bijvoorbeeld "Er is sinds die tijd nog één release of samengevoegde wijziging binnengekomen."

Wat elke uitvoering doet#

1. Leest de wijziging. De release-opmerkingen, samengevoegde wijzigingen of changelog-items sinds de laatste uitvoering, of de woorden die je hebt opgegeven.
2. Vindt wat het beïnvloedt. Het controleert de video's en artikelen van het helpcentrum die je kunt bewerken, tot 40 per uitvoering. Alles daarboven wordt in het plan genoemd: "2 items meer kunnen worden beïnvloed: een taak bewerkt tot 40."
3. Leest elk beïnvloed item volledig en beslist wat het nodig heeft:

4. Spot nieuwe functies. Met Gebruik mijn app wordt een functie die nog nergens wordt behandeld, vermeld als een optionele nieuwe video, niet aangevinkt: "Eén nieuwe functie zou een eigen video kunnen gebruiken (niet geselecteerd)."

Met jouw app verkent Clevera opnieuw alleen de gebieden die zijn veranderd, dus schermen die niet zijn veranderd, worden niet opnieuw opgenomen. Zonder app zegt een regel die moet worden opgenomen: "Om het opnieuw op te nemen, start je deze taak opnieuw met het adres en de inloggegevens van jouw app."

Wanneer een uitvoering niets vindt om te wijzigen, eindigt deze als Klaar met "Deze keer was niets nodig." en ontvang je geen melding.

Beoordeel en voer het plan uit#

Elk plan wacht onder Heeft jou nodig, en de chat waarin je het hebt ingesteld, krijgt een bericht wanneer het klaar is. Correcties voor bestaande inhoud zijn aangevinkt; video's voor nieuwe functies zijn niet aangevinkt. Elke regel toont de credits. Vink uit wat je niet wilt en klik op Uitvoeren, of Vraag om wijzigingen om een nieuw plan te krijgen. Een artikelcorrectie wordt opgeslagen als een nieuwe revisie van het artikel; een correctie kan ongedaan worden gemaakt met Ongedaan maken op de voltooide regel.

Kosten#

Bekijken, controleren en plannen zijn gratis. Elke correctie toont de credits op de planregel voordat je deze uitvoert, en je betaalt voor wat er daadwerkelijk wordt gebruikt. Een typische uitvoering kost 10–150 credits en duurt 5–90 minuten: tekstcorrecties kosten een paar credits, het opnieuw opnemen van een scherm kost meer.

Wijzigen, pauzeren of stoppen#

Op de taakpagina heeft de Houd het up-to-date kaart Pauze / Hervatten, Bewerken en Verwijderen. Wijzigen opent de agent, die aanbiedt om te wijzigen wat de taak elke keer doet of het budget ervan, of om deze te pauzeren of nu uit te voeren. Wat de taak start (een repository, een changelog-pagina) kan niet worden gewijzigd: de agent biedt aan om een nieuwe taak in te stellen met de nieuwe trigger, waarna je deze kunt verwijderen. Zie Een Autopilot-taak wijzigen.

Probleemoplossing#

Gerelateerd#