Så här får du feedback på din dokumentation i WordPress

Skriva dokumentation är ingen lätt uppgift. Det tar mycket tid och energi att skriva bra dokumentation för någon produkt, tjänst eller teknik. Men all denna insats och tid skulle vara bortkastad om användarna inte tycker det är till hjälp. För att överbrygga denna klyfta ger större företag en enkel feedbackformulär i slutet av deras dokumentationsartiklar som frågar användaren en enkel fråga "Fann du den här artikeln användbar?". Nyligen har vi funnit ett behov av en lösning som gör det möjligt för oss att få användarfeedback på vår dokumentation när vi arbetar med ett kundprojekt. I den här artikeln visar vi hur du får läsare feedback på din dokumentation i WordPress.

Det första du behöver göra är att installera och aktivera plugin för dokumentåterkoppling. När du har aktiverat plugin läggs till en fin liten prompten i slutet av dina WordPress-sidor som ber om användaråterkoppling.

När användare klickar Ja, de frågas vilka uppgifter de fann användbara.

Annars, om en användare klickade Nej, de frågas vilken information de skulle vilja se här.

Pluggen visar sedan dokumentåterkopplingen till författarna / administratörerna.

Det här pluginet är ganska nytt, och det är i barnets scen. Plugin är som standard begränsad till sidor. Du kan dock aktivera inlägg, sidor och annan posttyp som du vill ha. Allt du behöver göra är att lägga till följande kod i ett sajtspecifikt plugin:

 // Dokument Feedback Filter funktion wpb_new_document_post_type ($ post_types) $ post_types = array ('sida', 'post'); // Lägg till posttyp returnera $ post_types;  add_filter ('document_feedback_post_types', 'wpb_new_document_post_type'); 

Lägg bara till en annan posttyp som du vill ha i matrisen ovan.

Plugin är också begränsad till inloggade användare. Det fungerade bra för vårt användningsfall eftersom dokumentationen endast var tillgänglig för registrerade kunder. Från seriet av pluginens utvecklings kommentarer verkar det som om författaren har planer på att göra den tillgänglig för utloggade användare också.

Detta plugin ger snabb privat återkoppling för att förbättra dina dokumentationssidor. Det är bättre än att bädda in en kontaktformulär längst ner på dokumentationssidorna eller aktivera kommentarer. Låt oss veta hur du får användaråterkoppling om dokumentation på dina webbplatser?