Återkoppling på dokumentationen

Varje dokumentationssida i portalen slutar med Hjälpte det här?, och varje sökning i dokumentationen som en läsare skickar (Enter i sidhuvudets sökfält) och som inte hittar något räknas. Båda sparas på den här plattformen, så att du och Stackship kan se vad dokumentationen saknar, även på en installation utan internetåtkomst. Plattformen skickar dem aldrig någonstans: att skicka dem till Stackship gör du för hand.

Vad som sparas

Sparas	Sparas inte
Sidan, dess språk och modulversion, och svaret (ja eller nej)	Vem som svarade: inget namn, ingen e-postadress eller användar-id
En valfri kommentar på högst 500 tecken	Något om läsarens webbläsare eller nätverk
En sökning som skickades med Enter och inte hittade något alls (ingen sida, resurs eller dokumentation), hur ofta, och vilka dagar första och senaste gången	Vem som sökte
Plattformsversionen, och dagen (inte tiden) för varje svar

Varje person har ett svar per sida: ett nytt svar ersätter det första. För att det ska gå sparar plattformen en nyckelad hash av personen och sidan, som aldrig visas eller exporteras. Nyckeln härleds från plattformens krypteringsnyckel för data, som finns i en Kubernetes Secret och inte i databasen, så databasen eller en säkerhetskopia av den räcker inte för att koppla ett svar till en person.

Kommentarer är fritext. Portalen ber läsarna att inte skriva personuppgifter, men läs dem innan du skickar exporten vidare.

Återkoppling raderas 365 dagar efter att den senast gavs. Plattformen sparar högst 10 000 svar och 2 000 olika sökningar; när den är full tar den inte emot nya och behåller det den har, så ingen kan tränga undan andras återkoppling. Varje person kan skicka högst 100 svar och 100 sökningar per dag.

Se återkopplingen

Gå till Admin > Återkoppling på dokumentation, på https://portal.example.com/admin/docs-feedback. Sidan visar hur många svar som var hjälpsamma eller inte, hur många som hade en kommentar och hur många sökningar som inte hittade något; sidorna som läsarna tyckte hjälpte minst; och sökningarna som inte hittade något, de vanligaste först.

Skicka den till Stackship

1. På Återkoppling på dokumentation, välj Ladda ner JSON. Ladda ner CSV ger samma innehåll som en tabell, om du vill läsa det i ett kalkylark först. Filen innehåller plattformsversionen och när den exporterades.
2. Läs kommentarerna och sökorden i filen, och ta bort det du inte vill dela. Båda är fritext som dina användare har skrivit och kan nämna namn, resurser eller interna detaljer.
3. Skicka filen till din kontakt på Stackship, eller bifoga den i ett supportärende.

Plattformen laddar inte upp något, och inget ändras på plattformen när du laddar ner.

Vem som kan göra det här

Att ladda ner exporten kräver kernel/docsFeedback/export i plattformens rot. Platform Owner och Platform Contributor har den; Platform Reader har den inte. Att svara på Hjälpte det här? kräver ingen behörighet: alla inloggade användare kan göra det, inom dagsgränserna ovan och ett begränsat antal gånger per tio minuter.