Documentación de Stack Overflow para desarrolladores de Microsoft

Este post fue escrito por Jeff Sandquist, General Manager en la División de nube y empresa.

Hoy anunciamos una asociación con Stack Overflow para admitir la documentación de Stack Overflow para desarrolladores de Microsoft. Como parte de este anuncio, anunciamos que el contenido de la documentación de Stack Overflow se integrará en docs.microsoft.com contenido de referencia de la API en el futuro. Microsoft ha sido un socio de Stack Overflow en forma de etiquetas patrocinadas y el lanzamiento de la documentación de Stack Overflow permite a la comunidad tener una manera fácil de crear y votar ejemplos de código mediante .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 y simplificar para que la comunidad contribuya a una excelente documentación para usar 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 categorización familiar basada en etiquetas de los temas disponibles. A primera vista, verá todas las etiquetas creadas anteriormente por la comunidad stackOverflow. Una vez que filtre por etiqueta, aparecerá una lista de cada una con algunas métricas importantes que se muestran por adelantado: el recuento de solicitudes de tema, cambios propuestos y solicitudes de mejora.

Solicitar un tema

Pocos desarrolladores han resuelto problemas difíciles sin la ayuda de la audiencia de StackOverflow. Junto con nuestros compañeros, compañeros y leyendas de la comunidad que supervisan StackOverflow para preguntas relacionadas con sus propios productos, hemos creado una red de información organizada por etiquetas. La documentación pone en mayúsculas el compromiso del público con la creación colectiva de conocimientos al proporcionarnos un lugar para pedir ayuda: la sección "Temas solicitados" de cada etiqueta ofrece a la comunidad un lugar para identificar problemas comunes.

Al hacer clic en "Crear tema", puede crear contenido para el tema, proporcionar sus propios ejemplos de código y documentación. La experiencia proporciona instrucciones sobre dónde proporcionar cada sección de contenido, que se puede editar mediante la sintaxis de Markdown si lo prefiere. A medida que crea temas, el progreso se guarda en el panel de navegación correcto, donde puede ver todo el contenido del borrador que aún no ha completado o enviado para su revisión.

Experiencia familiar de visualización de código

Al igual que con stackOverflow Q&un sitio, el código para temas individuales se presenta en formato claro y conciso para que pueda copiar-editar-usar o aprender de simplemente leer el código. Los desarrolladores pueden obtener ejemplos de código de votación ascendentes o descendentes, al igual que las respuestas en Stack Overflow.

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 examinan la referencia de la API de Microsoft verán ambos ejemplos creados por Microsoft, así como los ejemplos de Stack Overflow creados por la comunidad. Los ejemplos se seleccionarán para asegurarse de que los ejemplos de código usan directrices de codificación de .NET establecidas y procedimientos recomendados. Publicaremos más detalles sobre esta integración en el futuro.