Dokumentáció áttekintése a GitHub-problémák használatával

Befejeződött

A Microsoft Learnhez való hozzájárulás egyik legléremesebb módja, ha közvetlenül egy dokumentációs cikkről ad visszajelzést. A lapon található visszajelzési hivatkozással szerkesztéseket, javaslatokat, kérdéseket vagy egyéb megállapításokat adhat meg a böngészés során. Mivel a Microsoft Learn dokumentációs tartalmainak többsége GitHub-adattárakban van tárolva, visszajelzését egy GitHub-folyamattal, a GitHub-probléma elküldésével küldheti el.

A GitHub egy olyan eszköz, amellyel a technológiai felhasználók, mérnökök és más Microsoft Learn-látogatók megoszthatják és nyomon követhetik az adott cikkekkel kapcsolatos visszajelzéseket. Kitölt egy űrlapot, amely dokumentálja a visszajelzést, és közzéteheti a forráscikk GitHub-adattárában, ahol értesítést kap egy szerzőről vagy tulajdonosról. A GitHub-adattárat felkeresők láthatják a problémákat. Hasznos módszerként szolgálnak értékes visszajelzések gyűjtésére és tárolására, például hibák, funkciókérések vagy jegyzetek jelentésére.

Miért érdemes áttekinteni a tartalmat a GitHubon?

A GitHubon a tartalomértékelések közvetlen módja annak, hogy szenvedélyes vagy tájékozott témákhoz járuljon hozzá. Ez azt jelenti, hogy ötleteit a Microsoft dokumentációjában található témakörök felfedezése közben is hozzáadhatja. A tudáskészlethez való hozzájárulás segít a Microsoft termékélményeinek javításában több millió felhasználó számára. Visszajelzései továbbadják a Microsoft Learn többi olyan látogatójának a tartalmát, akik a Microsoft-termékekre és azok támogató tartalmára támaszkodnak.

A Legtöbb esetben a GitHub-visszajelzések elküldésével ötleteit elküldheti a termék tartalomkészletéért felelős csapatnak. Ez az együttműködési út a tartalomcsapatok és a termékfelhasználók között lehetővé teszi a visszajelzések megosztását és megvitatására közvetlenül a GitHubon.

A dokumentációs tartalmakhoz való hozzájárulás szakmai előnyöket is nyújt Önnek. A GitHub egy jól ismert platform, ahol a technikai hozzájárulások elvégezhetők és nyomon követhetők. Minden alkalommal, amikor a GitHubon közreműködik egy projektben, az megjelenik a GitHub-profiljában. Idővel létrehozhat egy rekordot a közreműködésekről, hogy hozzáadhassa a technikai portfólióját.

Visszajelzés küldése a tartalomról

Ne feledje, hogy a Microsoft Learn számos dokumentációs cikkét a GitHub-adattárak tárolják. Számos GitHub-adattárban engedélyezve vannak a GitHub-problémák. Ha engedélyezve van, a learn.microsoft.com című cikk alján talál visszajelzést erről a lapról .

Screenshot of the feedback options at the bottom of a documentation article.

A probléma létrehozásához és elküldéséhez GitHub-fiókra van szükség. A Következő módon küldhet be problémát a GitHubon egy Microsoft Learn-cikkből:

  1. Jelentkezzen be a GitHub-fiókjába.

  2. Lépjen a Microsoft Learn dokumentációs cikkére, amelyről visszajelzést szeretne küldeni.

  3. A cikk alján keresse meg a Visszajelzés feliratú címsort. Itt megjelenik az Ez a lap feliratú mező.

    • Ha magáról a cikkről szeretne visszajelzést küldeni, válassza az Ez az oldal lehetőséget. Ekkor megjelenik egy üres Problémák űrlap a GitHubon, ahol megkezdheti a megjegyzések kitöltését. Ezt a lehetőséget most fogja választani.
    • Ha szeretné áttekinteni a témában elküldött egyéb GitHub-problémákat, válassza az Összes lap visszajelzésének megtekintése lehetőséget. Bárki elolvashat más GitHub-problémákat egy nyilvános adattárban, de ha van GitHub-fiókja, a problémákhoz megjegyzéseket is fűzhet.
    • A Termék kiválasztása lehetővé teszi, hogy visszajelzést küldjön magáról a termékről. Egyelőre nem részletezzük ezt a lehetőséget, hogy a dokumentációról visszajelzést küldhessünk.
  4. Miután kiválasztotta ezt a lapot, a rendszer kérni fogja, hogy jelentkezzen be a GitHub-fiókjába, ha még nem tette meg. Ezután megjelenik egy üres Problémák visszajelzési űrlap a GitHubon.

  5. Adjon meg egy címet a visszajelzéséhez, amely röviden összefoglalja a bemenetet.

  6. Az alábbi szövegmezőben írja le visszajelzését, és adja meg a szükséges kontextust. Az eszköztár használatával formázhatja a leírást, például idézőjelet, listát vagy említést adhat hozzá.

  7. Ha végzett, válassza az Új probléma elküldése lehetőséget.

Screenshot of a blank GitHub issues form to submit feedback on a documentation article.

Problémák nyomon követése

A probléma elküldésekor a cikk szerzője vagy más tartalomtulajdonosok értesítést kapnak. A probléma megjegyzéseit a GitHub-értesítések ellenőrzésével vagy az adattárba való visszatéréssel és a Problémák lap ellenőrzésével követheti nyomon.

Az adattárhoz beküldött egyéb problémákat a Problémák lapon is megvizsgálhatja, áttekintheti és megjegyzésekkel láthatja el.

Screenshot of the GitHub issues tab in a GitHub repo.