Google publica su propia guía de estilo para desarrolladores

ProyectosWorkspace

Los desarrolladores deben prestar especial atención a las indicaciones de la guía sobre cómo escribir buenos comentarios del código API y cómo documentar mejor la sintaxis de la línea de comandos.

Para ayudar a los desarrolladores a redactar mejor documentación y ampliar la posibilidad de participar en proyectos, Google ha hecho pública esta semana su propia guía de estilo para desarrolladores.

A menudo, la oferta y disponibilidad de documentación de desarrollo se ofrece de forma tardía a los desarrolladores, especialmente en los proyectos de código abierto, lo que dificulta la adaptación de los recién llegados a un proyecto.

En el caso de Google, esta es la misma guía de estilo que el gigante de Internet usa internamente para escribir la documentación de sus propios proyectos, como Kubernetes y Dart.

La guía incluye de todo, desde una lista de palabras para asegurar la ortografía de la jerga que se utiliza en la industria, a cómo y cuándo usar guiones o por qué se deben utilizar activos de voz y otros elementos básicos. Sin embargo, donde los desarrolladores deben prestar especial atención es a las indicaciones sobre cómo escribir buenos comentarios del código API y cómo documentar mejor la sintaxis de la línea de comandos.

Otras compañías, como WordPress y Salesforce, también han hecho públicas sus guías de estilo.

El equipo detrás de la guía de Google ha señalado que se trata de un documento vivo y que cambiará con el tiempo. También ha enfatizado que es solo una manera de hacer las cosas y no un estándar para la industria.

Leer la biografía del autor  Ocultar la biografía del autor