Documentação projeto de hardware

[Julio Cesar Torres]

Pessoal, imagino que essa vá para os engenheiros do grupo...

Em projetos de software, nós já estamos carecas de saber como funciona a documentação: dos requisitos à implementação existe uma série de artefatos e metodologias de desenvolvimento que podem ser aplicados em conjunto ou separadamente, para documentar e principalmente comunicar as decisões de projeto de um produto.

Mas e no projeto de hardware, como é? Somente os esquemáticos do circuito que vejo por aí. Quais são os documentos (se existem) que são feitos para passar a ideia do produto que está sendo criado?

É isso aí. Grande abraço,

Julio Cesar Torres
Membro do Calango Hacker Clube

[Jeronimo Avelar Filho]

Excelente pergunta , esse ano inclusive já rolou um seminario sobre documentacao de projetos open hardware . 

No open-source guardamos codigo-fonte, xmls de configuracao , scripts shell , etc mas essencialmente arquivos de texto. 

No open-hardware voce precisa guardar muita coisa , em diferentes formatos, para que outras pessoas possam reproduzir o projeto:

1 - Esquema eletrico -  no minimo os arquivos  sch e brd  das placas do projeto ,  se estiver usando eagle .

2 - Codigo fonte do firmware , bibliotecas usadas, scripts usados para  programar a MCU ,etc 

3 - Lista de material para construi-lo ( Bill of Materials, BOM LIST) 

4 - Arquivos CAD do gabinete , placa e outas peças mecanicas

5 - Arquivos com as medições de teste realizadas

6 - Registro das modificações feitas após tudo estar pronto e não funcionar como devia 

7 - etc

8 - etc

...

2013/9/17 Julio Cesar Torres <julio...@gmail.com>

--
--
Você recebeu esta mensagem porque está inscrito no
Grupo "arduino-brasília" nos Grupos do Google.
E-mail: arduino-...@googlegroups.com
Url: http://groups.google.com.br/group/arduino-brasilia?hl=pt-BR
Sair: arduino-brasil...@googlegroups.com

---
Você está recebendo esta mensagem porque se inscreveu no grupo "arduino-brasilia" dos Grupos do Google.
Para cancelar a inscrição neste grupo e parar de receber seus e-mails, envie um e-mail para arduino-brasil...@googlegroups.com.
Para obter mais opções, acesse https://groups.google.com/groups/opt_out.

--

Jeronimo Avelar Filho
http://blogdoje.com.br

-------------------------------------------------

Membro do Calango Hacker Club
-------------------------------------------------

[Paulo Soares]

High Level Question!!

Muito bom mesmo.

[Julio Cesar Torres]

Galera, 

dando uma pesquisada hoje, trombei com o CERN Open Hardware Licence, que descreve o que é a documentação de um projeto Open Hardware. Nas "Definitions", ela  define: 

"Documentation means schematic diagrams, designs, circuit or circuit board layouts, mechanical drawings, flow charts and descriptive text, and other explanatory material that is explicitly stated as being made available under the conditions of this Licence." 

Ou seja, em cima do que o Jerônimo nos explanou. Valeu mesmo! 

A propósito, outro dia estava rolando uma discussão aqui no fórum sobre qual licença adotar para um projeto. Daí sugiro dar uma olhada no CERN OHL disponível em http://www.ohwr.org/projects/cernohl/wiki . Achei conveniente, porque é uma licença pensada originalmente para projetos de open hardware, é patrocinado por uma baita instituição, e prevê o licenciamento tanto do hardware como do software. Fica aí a sugestão. 

É isso aí. Um grande abraço, 

Julio Cesar Torres 

Membro do Calango Hacker Clube

[Jeronimo Avelar Filho]

Outra referencia sobre o assunto é o site http://www.oshwa.org . Complementando a definição da documentação de projeto open-hardware é necessário disponibiliza-la publicamente em formatos que permitam a sua modificação de acordo com as licenças de uso definidas para o projeto. 

Valeu Julio

[Otávio Carneiro dos Santos]

Bacana, Júlio! Vou olhar lá.

Uma coisa que complica um bocado para mim é que eu não sei patavinas de nada e tudo que eu faço vai nascendo da experimentação. Nos meus projetos, o processo teria que ser um ciclo tipo: 

1 - fotografar peças que vou usar;

2 - montar um pedaço / módulo / componente;

3 - testar esse pedaço;

4 - adicionar / remover / ajustar peças;

Aí eu vou incrementando. Na hora que fico satisfeito, posso desmontar tudo, documentar e tentar montar de novo pra ver se funciona.

É um trem de doido, eu sei. Ainda estou experimentando e meu HD tá ficando cheio de fotos e vídeos de projetos pela metade que ainda não estão maduros o suficiente pra ir pro blog.

Acho que conforme eu for aprendendo, vai ficar mais natural. Hoje eu tenho que conferir em algum lugar os símbolos de todos os componentes antes de desenhar, o que torna o processo meio penoso.

Pra usar sua analogia, na área de software tem gente que já pensa em UML, não tem? Talvez um dia eu enxergue os diagramas na minha cabeça ao ver circuitos, mas por enquanto minha câmera é a minha melhor amiga nessas horas...

Espero ter contribuído.

Abs.,

Otávio

[Jeronimo Avelar Filho]

Otavio , essa é uma das razões razão de muita gente escrever blogs sobre projetos : cada post com fotos , rabiscos , rascunhos , pedaços de codigo ,  documenta mais uma iteração no projeto. 

Abs

2013/9/18 Otávio Carneiro dos Santos <otavio...@gmail.com>

[Wagner Leao]

Como os módulos de um projeto de hardware devem ter interface bem definida e podem trocar dados entre si, creio que UML atenda boa parte da documentação.
Na documentação um dos artefatos é o código fonte. Acho que esse seria o projeto em um programa de cad com esquema e placa. Não sei se é possível incluir notas para link entre o esquema, a placa e o restante da documentação.
Enfim, apesar de existirem diferenças, não creio que seja inviável documentar um projeto de hardware como um projeto de software.

[Edeilson Santos]

Boa Discussão,

Será que teria um site onde podemos colocar este arquivos, ou

a possibilidade de um 'guia' online para os projetos ?

"Antes de imprimir, pense em sua responsabilidade e compromisso com o MEIO AMBIENTE"

By Edeilson Bahia...

[Otávio Carneiro dos Santos]

Tem razão, Jerônimo. Acho que estou usando mal o blog...

Abs!

[Virgílio Matos]

Boa noite galera,

Eu tenho a mesma dificuldade e em certo momento devido a minha natureza profissional (Programador Web) sentei para desenvolver uma especie de rede social para compartilhamento de projetos e tutoriais para troca de conhecimento, assim como é o já conhecido Laboratório De Garagem, mas com toda a estrutura para cada um arquivar ou disponibilizar os diagramas, códigos, lista de peças e afins de seus projetos. Não segui com o projeto ainda pela complexidade que ele se tornou, no mesmo existia até um ranking pontuação para as pessoas que ajudavam respondendo perguntas, compartilhando projetos, postando tutoriais etc... Existia também um esforço em linkar automaticamente a referencia de qualquer componente para uma área do mesmo com informações fotos e até locais para compra.

Isso tudo em um ambiente colaborativo onde o conteúdo é gerado pelos usuários do site.

Estou a disposição para tocar o projeto ou até mesmo fazer algo mais simples quem sabe, mas realmente sozinho esta bem complicado, quem tiver interesse podemos combinar ou nos reunirmos.

Acredito que um ambiente fácil que atenda a comunidade na maior parte dessas demandas só tem a contribuir com nossa evolução e aproximar todos mais ainda.

Abraço a todos, boa noite.

Atenciosamente,

Virgílio Costa Matos

--

[Otávio Carneiro dos Santos]

Que legal, Virgílio!

Eu gostaria de contribuir... Já andei tendo umas idéias nessa linha também. Eu trabalho com Java, mas estou a fim de aprender outras coisas também, se já tiver definido outra tecnologia/plataforma.

Do lado funcional, pensei que poderíamos ter conquistas (badges) para premiar os participantes... 

Fala aí até onde você já foi para a gente ver como pode contribuir.

Abs.,

Otávio

--

--
Você recebeu esta mensagem porque está inscrito no
Grupo "arduino-brasília" nos Grupos do Google.
E-mail: arduino-...@googlegroups.com
Url: http://groups.google.com.br/group/arduino-brasilia?hl=pt-BR
Sair: arduino-brasil...@googlegroups.com
 
---
Você está recebendo esta mensagem porque se inscreveu no grupo "arduino-brasilia" dos Grupos do Google.
Para cancelar a inscrição neste grupo e parar de receber seus e-mails, envie um e-mail para arduino-brasil...@googlegroups.com.
Para obter mais opções, acesse https://groups.google.com/groups/opt_out.

[Virgílio Matos]

Que bom seu animo Otávio, 

Vou passar até onde eu cheguei sim mas antes acho bacana a ressalva que o Gabriel Peixoto fez.

Gabriel realmente o github como um host para projetos é simplesmente o melhor, e não a o que falar de uma estrutura wiki também para colaborar conhecimento.

Mas na verdade a minha vontade quando parei para criar algo não era só um repositório de projeto e conhecimento compartilhado, por mais que isso seja a essência da ideia.

A primeira questão que me deparei foi, como facilitar, instigar, incentivar uma pessoa a colaborar, essa é a parte que o mecanismo de ranking, pontuação  e rede social supostamente resolveria. Não adianta ter ferramentas boas mas ninguém usar

A segunda questão é centralizar e facilitar o acesso a informação, um projeto pode ter documentação digital, anexos, vídeos, fotos, códigos (com identação para uma fácil compreensão), perguntas, participantes, biblioteca de componentes, um canal de comunicação, moderação, eventos etc... (São tantas ideias boas que vem a mente imagino que muitos vão enxergar várias possibilidades). Enfim, no mercado eu não encontrei uma ferramenta que fizesse boa parte disso em sintonia e ainda fosse voltada para hardware e software, mas também posso estar enganado é bem possível que exista algo nesse sentido.

A terceira questão diz respeito ao nível de conhecimento, se eu conseguir associar uma pessoa a um conhecimento expecifico eu posso designar a mesma a sanar as dúvidas pertinentes a esse assunto ex: Digamos que eu tenha estudado bastante GPRS e tenha postado minha trajetória com projetos e tutoriais do assunto, ou simplesmente informei que já tenho essa bagagem de conhecimento, e um novo membro da comunidade acabou de começar seu TCC sobre o assunto (não conhece ninguem e mau sabe formular uma pergunta), é fato que o mesmo vai se deparar com várias dúvidas que eu poderia ajudar de maneira simples, melhor ainda tornar essa dúvida pública e documentada para consulta alem de pontuar a pessoa que ajudou como uma maneira de estimular. Fazer esse processo em um fluxo automático seria sensacional.

Existem outros pontos muito bacanas também mas o grande dúvida que eu tinha e tenho ainda hoje é se essas idéias são aderentes e boas para os outros assim como são para mim, quem é programador sabe como é tentador sentar e começar a fazer um projeto focado em uma vontade pessoal, mas no fundo o projeto tendo uma vertente comercial ou não a identificação do problema tem que ser muito bem trabalhada e posteriormente a ideia tem que ser muito bem documentada e amadurecida até chegar a hora de sentar e fazer.

Galera espero a opinião de vocês e Otávio vamos conversar se você estiver interesse mesmo em estudar essa possibilidade, o que fiz até agora esta em C# mas não me oponho a recomeçar do zero em algo novo, quem sabe um ruby on rails kkkkkkkk (o tempo esta escaço então onde pudermos empurrar um aprendizado novo ta ótimo)

Abraço boa noite.

[Virgílio Matos]

http://developer.github.com/

Estou lendo aqui para ver como seria na pratica.

Em 19 de setembro de 2013 22:18, Gabriel Peixoto <gpei...@gmail.com> escreveu:

Aliás se a API der um vasto acesso às funcionalidades do github seria interessante criar o projeto como uma "interface" com algumas novas funcionalidades mas com o github como backend.

--------------------------------------------------
Gabriel Peixoto

Registered Linux User: #229057

--------------------------------------------------

2013/9/19 Gabriel Peixoto <gpei...@gmail.com>

As vezes o github tem alguma API que fornece acesso as estatísticas de contribuição em um repositório ... baseada nelas você pode formar o rank em um site :)

Eu topo essa parada ae ! Sou noob em programação mas to querendo é me enfiar no meio tb em contribuir !

--------------------------------------------------
Gabriel Peixoto

Registered Linux User: #229057

--------------------------------------------------

2013/9/19 Virgílio Matos <virgili...@gmail.com>

[Otávio Carneiro dos Santos]

Pessoal, eu tinha guardado essa thread aqui para ver melhor depois, desculpem ressuscitá-la...

Eu estava lendo sobre uma impressora 3d aqui (a 3dr delta) e o cara deu uma dica de tema para o github que parece funcionar bem para impressoras 3d, então poderia servir para outros projetos de hardware, vejam:

Exemplo de uso: http://richrap.github.io/3DR-Delta-Printer/

Página do template: https://github.com/garyhodgson/githubiverse-template

Ainda não sou usuário ativo do git, mas acho que vou tentar aplicar isso aí a um projeto.

Abs.,

Otávio