Introdução à documentação
Bem-vindo ao início da documentação da CT Junior.
🤔 Por que fazer?
Para que possamos manter um bom fluxo de manutenção do conhecimento na CT Junior, é necessário que façamos documentações sucintas e precisas que facilitem a entrada de novos membros e ajude a relembrar e padronizar os procedimentos.
💡 O que precisamos para iniciar a criar uma documentação?
- Conhecimento em Markdown, você pode aprender sobre aqui.
- Conhecimento de Git/Github (ou alguém que possua por você na diretoria de tec*, rs).
- Conhecimento sobre o assunto a ser tratado no manual/documentação.
⚙️ Como criar minha documentação
A criação do documento
Sou de tecnologia ou prefiro o caminho difícil (Editando o projeto)
- Faça um clone do projeto no Github.
- Abra a pasta docs.
- Crie o arquivo .md no local desejado.
- Boa criação. 😄
Caso esteja procurando criar mais uma pasta basta observar o padrão do projeto ou ler mais sobre o Docusaurus, a ferramenta de criação deste manual.
Caso você não seja de tecnologia ou não queira abrir o projeto inteiro para criar um documento apenas, utilize um editor online como este, caso seja de tecnologia ou queira fazer pelo projeto, basta fazer um clone do projeto no Github
Não sou de tecnologia (Apenas criar o arquivo)
- Abra um editor online de Markdown como este.
- Inicie seu documento copiando o esqueleto de manual em A estrutura dos manuais.
- Envie para alguém de tecnologia para que possa ser colocado aqui. 🤓
A estrutura dos manuais
# Título
## 🤔 Por que fazer?
## 💡 O que precisamos para [...]? (Requisitos)
## ⚙️ Como [...] (Manual)
## 🤝 Dicas úteis: (ou Observações)
Para criar uma nova documentação, sempre busque manter o padrão e manter palavras simples e descomplicadas, além de trazer links complementares sempre que possível.
Sinta-se livre para alterar os emojis e utilizar sua criatividade na hora de criar manuais, desde que sejam simples, visuais, didáticos e mantenham a forma padrão dos manuais!
🤝 Dicas úteis:
- Para abrir o teclado de emojis no Windows basta pressionar Windows 🪟 + .