Granska dokumentationen med hjälp av GitHub-problem

Slutförd

Ett av de mest användbara sätten att bidra till Microsoft Learn är att ge feedback direkt i en dokumentationsartikel. Med hjälp av feedbacklänken på sidan kan du ge redigeringar, förslag, frågor eller andra insikter när de kommer upp i din surfning. Eftersom de flesta Microsoft Learn-dokumentationsinnehåll lagras i GitHub-lagringsplatser kan du ge feedback med hjälp av en GitHub-process som kallas att skicka ett GitHub-problem.

Ett problem i GitHub är ett verktyg som gör det möjligt för teknikanvändare, tekniker och andra Microsoft Learn-besökare att dela och spåra feedback om en viss artikel. Du fyller i ett formulär för att dokumentera din feedback och publicera det på källartikelns lagringsplats i GitHub, där en författare eller ägare meddelas. Alla som besöker GitHub-lagringsplatsen kan se Problem. De fungerar som ett användbart sätt att samla in och lagra värdefull feedback, som att rapportera buggar, funktionsförfrågningar eller anteckningar.

Varför ska du granska innehåll i GitHub?

Att tillhandahålla innehållsgranskningar på GitHub är ett direkt sätt att bidra till ett ämne som du är passionerad eller kunnig om. Det innebär att du kan lägga till dina idéer när du utforskar ett ämne i Microsoft-dokumentationen. Genom att bidra med dina insikter till kunskapspoolen kan du förbättra Microsofts produktupplevelser för miljontals andra användare. Din feedback främjar innehåll för andra Microsoft Learn-besökare som förlitar sig på Microsoft-produkter och deras stödinnehåll.

I de flesta fall kan du skicka GitHub-feedback så att du kan skicka dina idéer till teamet som ansvarar för produktens innehållsuppsättning. Den här samarbetsvägen mellan innehållsteam och produktanvändare gör att feedback kan delas och diskuteras direkt i GitHub.

Att bidra till dokumentationsinnehåll kan också ge dig professionella fördelar. GitHub är en välkänd plattform där tekniska bidrag kan göras och spåras. Varje gång du bidrar till ett projekt på GitHub återspeglas det i din GitHub-profil. Med tiden kan du skapa en post med dina bidrag för att lägga till din tekniska portfölj.

Så här ger du feedback om innehåll

Kom ihåg att många dokumentationsartiklar på Microsoft Learn lagras i GitHub-lagringsplatser. Många GitHub-lagringsplatser har GitHub-problem aktiverade. När du är aktiverad kan du hitta alternativet att skicka feedback för den här sidan längst ned i en artikel om learn.microsoft.com.

Skärmbild av feedbackalternativen längst ned i en dokumentationsartikel.

För att skapa och skicka ett problem behöver du ett GitHub-konto. Så här skickar du ett problem i GitHub från en Microsoft Learn-artikel:

  1. Logga in på ditt GitHub-konto.

  2. Gå till dokumentationsartikeln för Microsoft Learn där du vill ge feedback.

  3. Längst ned i artikeln hittar du rubriken med etiketten Feedback. Här visas en ruta med etiketten Den här sidan.

    • Om du vill ge feedback om själva artikeln väljer du Den här sidan. Detta tar dig till ett tomt ärendeformulär på GitHub där du kan börja fylla i dina kommentarer. Du väljer det här alternativet nu.
    • Om du vill granska andra GitHub-problem som skickats i ämnet väljer du Visa all sidfeedback. Vem som helst kan läsa andra GitHub-problem på en offentlig lagringsplats, men om du har ett GitHub-konto kan du också kommentera problemen.
    • Om du väljer Den här produkten kan du ge feedback om själva produkten. Vi går inte in närmare på det här alternativet för tillfället så vi kan fokusera på att ge feedback om själva dokumentationen.
  4. När du har valt Den här sidan uppmanas du att logga in på ditt GitHub-konto om du inte redan har gjort det. Sedan visas ett tomt formulär för feedback om ärenden i GitHub.

  5. Ange en rubrik för din feedback som kort sammanfattar dina indata.

  6. I textrutan nedan beskriver du din feedback och anger eventuella nödvändiga kontexter. Använd verktygsfältet för att formatera beskrivningen, till exempel lägga till ett citattecken, en lista eller ett omnämnande.

  7. När du är klar väljer du Skicka nytt problem.

Skärmbild av ett tomt GitHub-ärendeformulär för att skicka feedback om en dokumentationsartikel.

Spåra problem

Artikelns författare eller andra innehållsägare meddelas när du skickar problemet. Du kan spåra kommentarer om problemet genom att kontrollera dina GitHub-meddelanden eller gå tillbaka till lagringsplatsen och kontrollera fliken Problem .

Du kan utforska, granska och kommentera andra problem som har skickats för lagringsplatsen på fliken Problem .

Skärmbild av fliken GitHub-problem på en GitHub-lagringsplats.