Contribua com a Oobj Docs
Temos uma grande tarefa: migrar todo o conteúdo da Oobj Wiki para esta nova documentação, a Oobj Docs.
O trabalho é grande e, por isso, toda ajuda é mais do que bem-vinda!
Visão geral
Antes de começar a produzir conteúdos, é fundamental que você conheça alguns conceitos, processos e ferramentas que utilizamos:
- Seguimos a filosofia
docs-as-code: em termos gerais, isso significa que criamos conteúdos com as mesmas ferramentas que desenvolvedores utilizam para escrever códigos; - Construído com Docusaurus: este site de documentação foi criado com o Docusaurus, um gerador de sites estáticos open source, mantido pela Meta (Facebook);
- Utilizamos Markdown: essa é uma linguagem de marcação simples, que utilizamos para formatar os textos. Saiba mais sobre a sintaxe básica Markdown no site The Markdown Guide e na área de Recursos Markdown da documentação Docusaurus;
- Somos guiados pelo Diátaxis: caso você não conheça o framework, leia o artigo Organização do conteúdo;
- Seguimos algumas boas práticas de escrita: leia a página de Boas práticas em Tech Writing para escrever suas documentações no padrão da Oobj;
- Peça ajuda no Discord: não precisa ter vergonha! Caso você tenha alguma dúvida, chame a equipe de documentação no canal do Discord #tech-writing.
Eu não sei programar, e agora?
Se você quer contribuir com a Oobj Docs, mas não tem familiaridade com as ferramentas descritas em Visão geral, mande uma mensagem no canal do Discord #tech-writing. A partir disso, o time irá avaliar seu caso e propor uma solução 😉
