Rivedere la documentazione usando i problemi di GitHub

Completato

Uno dei modi più utili per contribuire a Microsoft Learn è fornire un feedback direttamente su un articolo della documentazione. Usando il collegamento feedback nella pagina, è possibile fornire modifiche, suggerimenti, domande o altre informazioni dettagliate che possono emergere durante la navigazione. Poiché la maggior parte dei contenuti della documentazione di Microsoft Learn è archiviata nei repository GitHub, è possibile fornire il proprio feedback usando un processo di GitHub denominato invio di un problema di GitHub.

Un problema in GitHub è uno strumento che consente agli utenti tecnologici, ai tecnici e ad altri visitatori di Microsoft Learn di condividere e tenere traccia dei feedback su un articolo specifico. Si compilerà un modulo per documentare il feedback e lo si invierà al repository dell'articolo di origine in GitHub, in cui un autore o un proprietario riceverà una notifica. Chiunque visiti il repository GitHub può vedere i Problemi. Sono un modo utile per raccogliere e archiviare feedback utili, come la segnalazione di bug, richieste di funzionalità o note.

Perché rivedere i contenuti in GitHub?

Fornire revisioni di contenuti su GitHub è un modo diretto per contribuire a un argomento di cui si è appassionati o esperti. Ciò significa che è possibile aggiungere le proprie idee mentre si esplora un argomento nella documentazione Microsoft. Contribuire con le proprie intuizioni al pool di conoscenze consente di migliorare le esperienze dei prodotti Microsoft per milioni di altri utenti. I feedback contribuiscono a migliorare i contenuti disponibili ai visitatori di Microsoft Learn che si affidano ai prodotti Microsoft e ai relativi contenuti di supporto.

Nella maggior parte dei casi, l'invio di feedback su GitHub consente di inviare le proprie idee al team responsabile del set di contenuti del prodotto. Questo percorso di collaborazione tra i team di contenuti e gli utenti del prodotto consente di condividere e discutere i feedback direttamente su GitHub.

Contribuire ai contenuti della documentazione può offrire anche vantaggi professionali. GitHub è una nota piattaforma in cui è possibile fornire e tenere traccia dei contributi tecnici. Ogni volta che si contribuisce a un progetto su GitHub, ciò si riflette sul proprio profilo GitHub. Nel corso del tempo, sarà possibile creare un record dei contributi da aggiungere al proprio portfolio tecnico.

Come fornire un feedback sui contenuti

Tenere presente che molti articoli della documentazione su Microsoft Learn vengono archiviati nei repository GitHub. In molti repository GitHub sono abilitati i problemi di GitHub. Se abilitata, l'opzione per inviare un feedback per questa pagina si trova nella parte inferiore dell’articolo su learn.microsoft.com.

Per creare e inviare un problema, è necessario disporre di un account GitHub. Ecco come inviare un problema in GitHub da un articolo di Microsoft Learn:

1. Accedi all'account GitHub.

2. Passare all'articolo della documentazione di Microsoft Learn del quale si desidera fornire un feedback.

3. Nella parte inferiore dell'articolo è possibile trovare l'intestazione con etichetta Feedback. Qui viene visualizzata una casella con etichetta Questa pagina.

   • Per inviare un feedback sull'articolo stesso, selezionare Questa pagina. Verrà visualizzato un modulo Problemi vuoto su GitHub, in cui è possibile iniziare a compilare i commenti. Scegliere ora questa opzione.
   • Per rivedere altri problemi di GitHub inviati sull'argomento, selezionare Visualizza tutti i feedback della pagina. Chiunque può leggere altri problemi di GitHub in un repository pubblico, ma se si dispone d un account GitHub, è anche possibile commentare i problemi.
   • Selezionando Questo prodotto consente di fornire feedback sul prodotto stesso. Per ora non verrà descritta nel dettaglio questa opzione, in modo da concentrarsi sull’invio di feedback sulla documentazione stessa.

4. Dopo aver selezionato Questa pagina, verrà richiesto di accedere all’account GitHub, se non è già stato fatto. Quindi, in GitHub viene visualizzato un modulo di feedback dei Problemi vuoto.

5. Immettere un titolo per il feedback che riepiloghi brevemente il contributo.

6. Nella casella di testo seguente, descrivere il proprio feedback e fornire qualsiasi contesto necessario. Usare la barra degli strumenti per formattare la descrizione, ad esempio per aggiungere una citazione, un elenco o una menzione.

7. Al termine, selezionare Invia nuovo problema.

Tenere traccia dei problemi

L'autore dell'articolo o altri proprietari di contenuti verranno avvisati quando viene inviato il problema. È possibile tenere traccia i commenti sul problema controllando le notifiche di GitHub o tornando al repository e controllando la scheda Problemi.

È possibile esplorare, rivedere e commentare altri problemi inviati per tale repository nella schedaProblemi.