Para ajudar seus desenvolvedores e, principalmente, os recém-chegados, o Google publicou um guia de estilo com diretrizes para orientar as pessoas na hora de escrever a documentação para projetos relacionados à empresa.
Este é o mesmo guia de estilo que o Google usa internamente para escrever a documentação de seus próprios projetos e ele conta com desde uma lista de ortografia para o vocabulário do setor, como “data center” ao invés de “datacenter”, até orientações de como escrever bons comentários do código API.
“Este guia é um documento vivo; ele muda ao longo do tempo, e, quando ele muda, geralmente não alteramos a documentação publicada anteriormente para coincidir. Nós nos esforçamos por consistência, na medida do possível, mas a qualquer momento certamente haverá partes de nossa documentação que não combinam com este guia de estilo. Em caso de dúvida, siga este guia em vez de imitar documentos existentes”, afirma a empresa. O Google, no entanto, ressalta que o guia não fornece aconselhamento jurídico.
Tags: