Un nuovo sistema di feedback verrà docs.microsoft.com
Questo post è stato scritto da Rob Eisenberg, Senior Program Manager nel team docs.microsoft.com.
La missione di Microsoft è quella di consentire a ogni persona e a ogni organizzazione del pianeta di ottenere di più. Questa è stata una delle considerazioni che abbiamo creato docs.microsoft.com sulla piattaforma GitHub aperta. Oggi lo stiamo portando al livello successivo con il passaggio a un nuovo sistema di feedback della documentazione basato su GitHub.
Commenti e suggerimenti sul contenuto su GitHub
Anche se la documentazione è disponibile in GitHub fin dall'inizio, il meccanismo di feedback dei contenuti usa Livefyre per i commenti sugli articoli. Anche se Livefyre è una soluzione di commento ottimale, risulta insufficiente per le esigenze specifiche, che consiste nel tenere traccia, assegnare i proprietari e mantenere lo stato dei problemi di contenuto generati dai clienti.
Sono state esaminate diverse strade per renderla migliore, ma una domanda che ha guidato gran parte del nostro lavoro sembrava riprovare: Se la documentazione fosse trattata proprio come codice open source, cosa useremo per risolvere questo problema? La risposta alla domanda sembrava ovvia: Problemi di GitHub, quindi abbiamo iniziato a sperimentare l'integrazione delle API GitHub più profondamente nelle pagine della documentazione, essendo in grado di creare un sistema di feedback completo sull'infrastruttura GitHub.
Con il nuovo sistema, è ora possibile creare problemi di GitHub direttamente da una pagina del contenuto, che consente di interagire in modo molto più completo con writer e team di prodotto. Vedere un problema con un documento? Un esempio di codice non valido? Una spiegazione confusa? Un'omissione critica? È sufficiente scorrere fino alla fine della pagina e selezionare Inviare commenti e suggerimenti sulla documentazione.
È possibile visualizzare tutti i problemi aperti e chiusi associati al documento, direttamente dalla pagina della documentazione stessa, in questo modo si è sempre in grado di sapere quando gli elementi vengono risolti e risolti:
È possibile commentare e anche aggiungere reazioni a problemi importanti per te:
Ora, i dipendenti Microsoft possono sfruttare tutte le potenzialità dei problemi di GitHub per valutare, rispondere, pianificare e risolvere i problemi segnalati e avere sempre visibilità sul processo.
Feedback sulla documentazione di esempio
Si supponga di segnalare un problema di GitHub per un collegamento ipertestuale interrotto in un articolo. Il team eseguirà la valutazione del problema, assegnerà un'etichetta e assegnerà un proprietario per apportare la correzione (o porre domande di completamento). Quando il proprietario invia una richiesta pull che risolve il problema, si riceverà una notifica (in base alle impostazioni di notifica di GitHub), che il problema è stato risolto/chiuso, creando un ciclo virtuoso di feedback.
Inoltre, è possibile sfruttare tutte le qualità standard di GitHub, ad esempio Markdown nei commenti, sottoscrizioni a singoli problemi o interi repository, feed RSS dell'attività dell'organizzazione, @ menzioni, assegnatari e altro ancora. Crediamo che un livello più profondo di integrazione degli strumenti open source favorisce nuove opportunità per la crescita e la collaborazione della community.
Separazione dei commenti e suggerimenti dei prodotti
Uno dei problemi con il sistema precedente è stato il mix tra il feedback del prodotto e la documentazione in un unico flusso - era estremamente difficile valutare e seguire, quando non tutti gli elementi sono etichettati in modo coerente. Abbiamo fatto un passo avanti per risolvere questo problema creando un modo chiaro per separare i due:
Facendo clic su Inviare commenti e suggerimenti sul prodotto, si verrà ora portati direttamente al sito in cui il team del prodotto associato alla pagina della documentazione specifica gestisce il feedback del prodotto.
Roll-Out
Ci si potrebbe chiedere quando il sistema di feedback sarà attivo. La distribuzione pilota è stata completata per un paio di mesi per il dell'IDE di Visual Studio e la documentazione dell'interfaccia della riga di comando di Azure . A partire da metà febbraio, inizieremo a implementare questa funzionalità in tutti i docs.microsoft.com.
Commenti e suggerimenti
Il feedback è importante per noi, quindi vogliamo ottenere rapidamente questo nuovo sistema nelle mani. Anche se è il nostro passo successivo per migliorare il feedback e il coinvolgimento sulla nostra piattaforma, non è per niente il nostro ultimo passaggio. Assicurarsi di inviare commenti e suggerimenti sulle modifiche in GitHuboppure contrassegnarci su Twitter.