Sobre os princípios de design de conteúdo do GitHub
Criamos a documentação do produto que ajuda, ensina e envolve todos que usam o GitHub. Uma etapa desse trabalho é projetar o conteúdo que escrevemos. Seguimos esses princípios ao projetar e planejar o conteúdo.
- Nosso conteúdo é centralizado no usuário e inclusivo. Respeitamos todos que acessam a documentação e criamos um conteúdo que funciona para eles com nossas escolhas de estratégia, design e estilo.
- Nosso conteúdo explica por que nossos produtos são úteis e ajuda as pessoas a alcançar as metas e as prioridades.
- Empregamos nossos recursos criando uma documentação valiosa e de alta qualidade para a comunidade do GitHub.
- Criamos uma documentação sob medida. Quanto mais conteúdo, mais tudo se torna difícil de encontrar e qualquer item adicionada dilui todo o resto (GitHub Zen).
- Iteramos e fornecemos conteúdo para aprendermos. À medida que aprendemos mais com a experiência, o conhecimento do setor e o trabalho com nossa comunidade do GitHub Docs, ajustamos nossos processos, nossas práticas e diretrizes.
Fornecemos um guia de estilo e modelos de conteúdo como blocos de construção e diretrizes para qualquer pessoa projetar e criar a documentação.
- Nosso guia de estilo e os modelos de conteúdo se aplicam a uma variedade de cenários.
- As decisões são baseadas no que é melhor para as pessoas que usam nossa documentação, não simplesmente no que é certo ou errado de acordo com as regras gramaticais ou de estilo. Somos flexíveis e abertos a alterações, mantendo a consistência.
- Concentramos nossa atenção na documentação de cenários de alto impacto e alto valor, em vez de tentar abordar de maneira abrangente todos os casos de uso possíveis para os muitos produtos e recursos do GitHub.
- Nossas prioridades mais altas são clareza, significado, correção e consistência.
- Ao tomar uma decisão de estilo ou de estrutura, consideramos o que as pessoas estão tentando fazer com as informações e como nosso conteúdo pode dar melhor suporte às respectivas metas.
- Quando uma pergunta específica sobre a documentação não é abordada pelo guia de estilo ou pelo modelo de conteúdo, nós a avaliamos usando esses princípios e, em seguida, tomamos uma decisão.