Inicio rápido del estilo y la voz de Microsoft Learn

  • Artículo

Este inicio rápido es una breve guía para escribir contenido técnico para su publicación en Microsoft Learn. Estas instrucciones se aplican para crear documentos o actualizar los existentes.

Procedimiento recomendado:

  • Compruebe la ortografía y la gramática de los artículos, aunque tenga que copiar y pegar el texto en Microsoft Word para hacerlo.
  • Use un tono informal y amable, como si estuviera hablando con otra persona cara a cara.
  • Use oraciones sencillas. Oraciones fáciles de leer significa que el lector puede usar rápidamente la guía que usted comparte.

Use los principios sobre el tono de Microsoft

Aspiramos a seguir estos principios cuando escribimos contenido técnico para Microsoft Learn. No siempre lo conseguimos, pero tenemos que seguir intentándolo.

  • Céntrese en la intención: los clientes tienen un objetivo específico en mente cuando consultan nuestra documentación. Antes de empezar a escribir, determine con claridad quién es el cliente y qué tarea pretende llevar a cabo. Después, escriba el artículo para ayudar a ese cliente específico a realizar esa tarea concreta.
  • Use un lenguaje cotidiano: trate de usar un lenguaje natural, es decir, las palabras que los clientes usan. Sea menos formal, pero no menos técnico. Proporcione ejemplos que expliquen los nuevos conceptos.
  • Escriba de forma concisa: no malgaste palabras. Use oraciones afirmativas y no utilice palabras adicionales ni multitud de calificadores. Escriba oraciones cortas y concisas. Centre el artículo en el asunto tratado. Si una tarea tiene un calificador, colóquelo al principio de la oración o del párrafo. Además, utilice el menor número de notas posible. Use una captura de pantalla cuando se pueda ahorrar palabras.
  • Facilite el análisis de los artículos: coloque primero los elementos más importantes. Use secciones para fragmentar procedimientos largos en grupos de pasos que se puedan administrar con más facilidad. (Los procedimientos con más de doce pasos posiblemente resulten demasiado largos). Use una captura de pantalla cuando aporte claridad.
  • Muestre empatía: use un tono servicial en el artículo y use el mínimo número posible de avisos de exención de responsabilidad. Destaque con franqueza las áreas que causarán frustración a los clientes. Asegúrese de que el artículo se centra en lo que importa al cliente, no se limite exclusivamente a una presentación técnica.

Consideraciones sobre localización y traducción automática

Los artículos técnicos están traducidos en varios idiomas, y algunos se modifican para mercados o regiones geográficas concretos. Los usuarios pueden recurrir también a la traducción automática en la Web para leer los artículos técnicos. Por tanto, debe tener en cuenta las siguientes pautas cuando escriba:

  • Asegúrese de que el artículo no contiene errores de gramática, ortografía o puntuación: se trata de un procedimiento que deberíamos aplicar por norma general. Algunos editores Markdown, como Markdown Pad 2.0, incorporan un corrector ortográfico básico, pero es conveniente pegar el contenido HTML representado del artículo en Word, ya que este procesador incorpora un corrector ortográfico y gramatical más eficaz.
  • Escriba oraciones lo más cortas posibles: las oraciones compuestas o las cadenas de cláusulas dificultan la traducción. Divida las oraciones si es posible, sin que sean demasiado redundantes o de tal forma que no suenen raras. No queremos artículos escritos en un lenguaje que no sea natural.
  • Use construcciones gramaticales sencillas y coherentes: la coherencia es mejor para la traducción. Evite los paréntesis y las acotaciones y coloque el sujeto lo más cerca posible del principio de la oración. Consulte algunos artículos publicados. Si algún tema tiene un estilo agradable y fácil de leer, úselo como modelo.
  • Use una redacción y una capitalización coherentes: una vez más, la coherencia es la clave. No escriba con inicial mayúscula una palabra si no está al principio de una oración o si no se trata de un nombre propio.
  • Incluya las "palabras cortas": las palabras que se consideran cortas y sin importancia en español porque se entienden por el contexto (como "un", "la", "esa" y "es") son fundamentales para la traducción automática. Por esta razón, debe asegurarse de incluirlas.

Otras cuestiones que hay que tener en cuenta sobre el estilo y el tono

  • No interrumpa pasos con comentarios o acotaciones.
  • Para los pasos que incluyen fragmentos de código, inserte información adicional sobre el paso en el código como comentario. De esta forma, se reduce la cantidad de texto que hay que leer. La información clave se copia en el proyecto de código para recordar a los lectores lo que hace el código cuando hacen referencia a él más adelante.
  • Escriba todos los títulos y los encabezados con la primera letra en mayúscula.
  • Use "iniciar sesión" en lugar de "registrarse".
  • Para obtener más instrucciones, vea la Guía de estilo de escritura de Microsoft.

Documentación localizada

  • Si contribuye a la documentación localizada, consulte las referencias de globalización.
  • Para consultar las instrucciones de localización, información sobre el estilo y el uso del idioma en las publicaciones técnicas e información sobre formatos de datos específicos según el mercado, descargue la guía de estilo en su idioma.
  • Consulte la Terminología de Microsoft para buscar terminología aprobada específica de un producto o para descargar la colección de terminología de Microsoft en su idioma.
  • Para obtener más información sobre la localización, vea "Comunicaciones globales" en la Guía de estilo de escritura de Microsoft.

Nota:

La mayoría de la documentación localizada no ofrece la posibilidad de editarse ni de proporcionar comentarios mediante GitHub. Para proporcionar comentarios sobre el contenido localizado, utilice el formulario https://aka.ms/provide-feedback.