Contribuir a la documentación de Microsoft Teams

La documentación de Teams forma parte de la biblioteca de documentación técnica de Microsoft docs . El contenido se organiza en grupos denominados docsets, cada uno de los cuales representa un grupo de documentos relacionados que se administran como una entidad única. Los artículos de la misma docset tienen la misma extensión de ruta de dirección URL después de docs . Microsoft.com. Por ejemplo, /docs.microsoft.com/microsoftteams/... es el comienzo de la ruta de acceso del archivo docset de Teams. Los artículos de Microsoft Teams se escriben en la sintaxis de MarkDown y se hospedan en GitHub.

Configurar el área de trabajo

  • Instalar desde VS Code:
  1. Seleccione el icono extensiones en la barra de actividad lateral o use el comando View => Extensions (Ctrl + Mayús + X) y busque el paquete de creación de documentos (Microsoft).
  2. Seleccione el botón instalar .
  3. Una vez completada la instalación, el botón instalar cambiará al botón administrar engranaje.

Revisión de la guía de colaboradores de Microsoft docs

La Guía de colaboradores ofrece dirección para crear, publicar y actualizar contenido técnico en Microsoft/docs. Consulte también, estilo docs y inicio rápido de voz .

Guías de escritura, estilo y contenido de Microsoft

  • Guía de estilo de escritura de Microsoft. Considere la posibilidad de agregar esta guía en línea al menú Favoritos de su explorador. Es un recurso exhaustivo para la escritura técnica actual y refleja el enfoque moderno de Microsoft hacia voz y estilo.

  • Escribir contenido para programadores. El contenido específico de Microsoft Teams está dirigido a un público de programadores con una comprensión fundamental de los conceptos y procesos de programación. Es importante que proporcione información clara y técnicamente precisa de manera convincente a la vez que mantiene el tono y el estilo de Microsoft.

  • Escribir instrucciones paso a paso. Las experiencias interactivas y aplicadas son una buena forma de que los programadores obtengan información sobre los productos y tecnologías de Microsoft. Presentar procedimientos complejos o sencillos en un formato progresivo es natural y fácil de tener al usuario.

Referencia de MarkDown

Las páginas de Microsoft docs se escriben en la sintaxis de MarkDown y se analizan a través de un motor de Markdig . Vea la referencia de docs Markdown para obtener etiquetas específicas y convenciones de formato.

Rutas de archivo

Establecer una ruta de acceso de archivo válida para los hipervínculos en la documentación puede ser un reto, especialmente cuando se usan rutas relativas y se crean vínculos a otros docsets. La compilación no tendrá éxito en GitHub si la ruta de acceso del archivo es incorrecta o no es válida.

Para obtener más información acerca de los hipervínculos y las rutas de archivo, vea usar vínculos en la documentación.

Importante

Para hacer referencia a un artículo que forma parte de la plataforma de Teams docset:
 ✔ usar una ruta de acceso relativa sin una barra diagonal inicial.
 ✔ incluir la extensión de archivo de Markdown.
Por ejemplo: directorio principal/directorio/ruta de acceso-a-article. MD : >[Building an app for Microsoft Teams](../concepts/building-an-app.md)

Para hacer referencia a un artículo de la biblioteca de Microsoft docs ( / ) que no forma parte de la plataforma de Teams docset:
 ✔ usar una ruta de acceso relativa que comience con una barra diagonal.
 ✔ no incluya la extensión de archivo.
Por ejemplo: /docset/Address-to-file-Location : >[Use the Microsoft Graph API to work with Microsoft Teams](/graph/api/resources/teams-api-overview)

Ejemplos de código y fragmentos de código

Los ejemplos de código desempeñan un papel importante en ayudar a los desarrolladores a usar las API y los SDK correctamente. Los ejemplos de código bien presentados pueden comunicar cómo las cosas funcionan con más claridad que el texto descriptivo y la información de las instrucciones sola. Las muestras de código deben ser precisas, concisas y bien documentadas, y, lo que es más importante, fácil de usar para los lectores. El código que es fácil de leer también es fácil de entender, probar, depurar, mantener, modificar y extender. Vea Cómo incluir código en documentos. Para obtener sugerencias de legibilidad, Consulte también Cutting Edge: sugerencias de legibilidad de código fuente.