Documentación de Stack Overflow para desarrolladores de Microsoft

El autor de este artículo es Jeff Sandquist, director general de la división de Cloud + Enterprise.

Hoy anunciamos una asociación con Stack Overflow que respalda la documentación de Stack Overflow para los desarrolladores de Microsoft. Como parte de este anuncio, comunicamos que el contenido de la documentación de Stack Overflow se integrará en el futuro con el contenido de referencia de la API de docs.microsoft.com. Microsoft lleva mucho tiempo colaborando con Stack Overflow en forma de etiquetas patrocinadas, y el lanzamiento de la documentación de Stack Overflow permite a la comunidad disponer de una forma sencilla de crear y votar ejemplos de código utilizando .NET Framework, Xamarin y otros productos y tecnologías de Microsoft.

Objetivos compartidos

Tanto docs.microsoft.com como Stack Overflow tenían objetivos compartidos: queremos facilitar que la comunidad contribuya con una excelente documentación para el uso de productos y servicios. Ambos conjuntos de contenido tienen una licencia abierta, usan Markdown como formato de contenido y habilitan fácilmente las contribuciones de la comunidad (haga clic en Editar desde cualquier página de docs.microsoft.com).

Un paseo rápido por Stack Overflow para desarrolladores de .NET

Cuando llegue por primera vez a la documentación de StackOverflow encontrará la familiar categorización de los temas disponibles basada en etiquetas. A primera vista verá todas las etiquetas creadas anteriormente por la comunidad stackOverflow. Una vez que filtre por etiqueta, aparece una lista de cada una con algunas métricas importantes que se muestran al principio: el recuento de solicitudes de temas, los cambios propuestos y las solicitudes de mejora.

Búsqueda de contenido mediante etiquetas

Solicitud de un tema

Pocos desarrolladores han resuelto problemas difíciles sin la ayuda de la audiencia de StackOverflow. Junto con nuestros colegas, compañeros y leyendas de la comunidad que supervisan StackOverflow en busca de preguntas relacionadas con sus propios productos, hemos creado una red de información organizada por etiquetas. La documentación aprovecha el compromiso de la audiencia con la construcción colectiva de conocimientos ofreciéndonos un lugar para pedir ayuda: la sección "Temas solicitados" de cada etiqueta ofrece a la comunidad un lugar para identificar problemas comunes.

Temas solicitados

Al hacer clic en "Crear tema", puede crear contenido para el tema, proporcionar sus propios ejemplos de código y documentación. La experiencia ofrece orientación sobre dónde proporcionar cada sección de contenido, que puede editarse utilizando la sintaxis Markdown si lo prefiere. A medida que crea temas, el progreso se guarda en el panel de navegación de la derecha, donde puede ver todos los borradores de contenido que aún no ha completado o enviado para su revisión.

Creación de un tema nuevo

Experiencia familiar de visualización de código

Al igual que en el sitio de preguntas y respuestas de StackOverflow, el código de los temas individuales se presenta en un formato claro y conciso para que pueda copiar-editar-usar o aprender simplemente leyendo el código. Los desarrolladores pueden votar los ejemplos de código mostrando satisfacción o insatisfacción, al igual que las respuestas en Stack Overflow.

Tema existente

Integración futura

En el futuro, docs.microsoft.com integrará una lista seleccionada de ejemplos de documentación de Stack Overflow directamente en la documentación de la API de Microsoft. Los desarrolladores que consulten la referencia de API de Microsoft verán tanto ejemplos creados por Microsoft como ejemplos de Stack Overflow creados por la comunidad. Los ejemplos de código estarán seleccionados para garantizar que utilicen las directrices de codificación de .NET establecidas y los procedimientos recomendados. Publicaremos más detalles sobre esta integración en el futuro.