-
Notifications
You must be signed in to change notification settings - Fork 1
Formato da documentaçao
A documentaçao deste projeto se encontra dividia em 2 fatias: documentaçao do codigo e instruçoes de utilizaçao:
1. Codigo: Toda a documentaçao do codigo, incluindo seu modo de funcionamento e explicaçao sobre funçoes e variaveis se encontra dentro do proprio codigo, em formato docstrings. Qualquer duvida ou contribuiçao sobre o funcionamento do codigo internamente deve ser feito mantendo este formato.
2. Instruçoes: A documentaçao de utilizaçao, isto é, todas as intruçoes para que alguem de dentro ou fora do projeto consiga montar esta plataforma e utiliza-la, incluindo aqui Lista de Componentes (BOM), instruçoes de montagem, especificidades de cada modelo de placa/sensor, instruçoes para manufatura de componentes, manual de utilizaçao, entre outros.