Encontros elaboração oficinas de documentação

Added by Flávio Depaoli about 5 years ago

Primeiro encontro para de brainstorm sobre as oficinas de documentação.
06/11/2015 as 14:45 no CTA. Presentes: Pedro Terra, Álvaro Essinger, Sebastian Gonçalves, Marina de Freitas, Jan Luc Tavares, Germano Postal, Nelso Jost, Renan Silva, Béuren Bechlin, Flavio Depaoli, Rafael Pezzi.

Fizemos uma conversa geral sobre o tema de documentação, falou-se de propriedade intelectual, ferramentas, boas práticas.

Continuaremos na sexta 13/11/2015 as 14:45.

Tópicos das Oficinas

Separar em atividades para oficinas curtas, longas e curso de documentação de projetos.

Ferramentas para documentação

  • Textos
  • Imagens (vetoriais e bitmaps)

Licenças

  • Conteúdo (Textos, imagens, sons, videos)
  • Software
  • Hardware

Aprimoramento das orientações de documentação

Linguagem a utilizar?

  • Ver orientações da wikipédia
  • Seguindo regras da gramática

Enriquecer descrição dos elementos no modelo de documentação

Bibliografia

  • Incluir referência sobre os assuntos do projeto, (o que você estudou para saber executar o projeto). Exemplo: tutoriais, paginas wiki, livros textos
  • palavras-chave

Estudo de Caso

Estações meteorológicas


Replies (5)

RE: Encontros elaboração oficinas de documentação - Added by Rafael Pezzi about 5 years ago

Algumas das discussões que tivemos na reunião de hoje foram a respeito de:

Definição de documentação

Conjunto de informações para viabilizar o uso, estudo, compreensão, adaptação e reprodutibilidade de projetos. É um esclarecimento do processo de criação de projetos.

Discutimos sobre as diferenças entre os termos ¨Hardware Livre¨ e ¨Hardware Aberto¨.

Para a próxima reunião:

  • Documentação de ensino:
    • Teremos que discutir na próxima reunião, pois houveram várias perspectivas a respeito da definição da doc. de ensino.
  • Objetivos da oficina.
  • Sugeriu-se desenvolvimento de teste de eficácia para a oficina/método.

Presentes: Béuren, Renan, Germano, Paulo, Nelso, Jan, Pezzi.

Esclarecimentos da motivação e objetivos da documentação de hardware e encaiminhamento - Added by Rafael Pezzi about 5 years ago

Alguns pensamentos sobre a motivação e objetivos da documentação de hardware levantados na conversa de hoje:

Inspirações para hardware livre, aberto e documentado.

O movimento de Recursos Educacionais Abertos (REA) promove materiais educacionais que possam ser usados, estudados, modificados e distribuídos. Diversas áreas utilizam instrumentos em atividades didáticas: desde os laboratórios de ciências da educação básica até os instrumentos de laboratório de cursos técnicos, ciências e engenharias.

O movimento Ciência Aberta está buscando o acesso universal aos produtos do processo científico, defendendo, além do acesso aberto às publicações científicas, o acesso a outras criações advindas do fazer científico como acesso aos programas de computador e instrumentos científicos.

São iniciativas que estão alinhadas com a definição de conhecimento aberto (ou Open Definition):

"Aberto significa que qualquer um pode livremente acessar, utilizar, modificar e compartilhar para qualquer propósito" http://opendefinition.org/

Por quê documentar o hardware?

A prática de documentação de hardware ainda é pouco difundida. Almejamos construir algo que possa vir a ter reconhecimento acadêmico.

Para a próxima reunião, 27/11 as 14:45 no CTA

  • Esclarecer o que é documentação de ensino (garantir que temos uma definição/esclarecimento do que é cada tipo de documentação)
    • Pedido para cada um que expôs sua visão de documentação de ensino: preparar uma frase que defina documentação de ensino para montar uma definição em comum acordo.
  • Definir objetivos da oficina de documentação. Esclarecer o que será abordado na oficina.

RE: Encontros elaboração oficinas de documentação - Added by Leonardo Sehn about 5 years ago

Minha percepção sobre o assunto documentação e documentação de ensino aqui descrita, pois não participarei da reunião:

- Cada documentação garante ao leitor tomar a ação a qual a documentação pretende esclarecer: a documentação de uso permite ao leitor usar, a de desenvolvimento a desenvolver e a de ensino a ensinar. Nesse sentido, a documentação de ensino será o conjunto de conteúdos que auxiliem o professor/tutor/mestre a ensinar a ferramenta e com a ferramenta, tais como práticas de ensino recomendáveis com a ferramenta, princípios fundamentais de funcionamento da mesma ou qualquer outra informação ou proposta cabíveis em relações de ensino relacionados.

RE: Encontros elaboração oficinas de documentação - Added by Béuren Bechlin almost 5 years ago

O que é possivelmente interessante de se saber a respeito de algum projeto:
  • Como "montar" o projeto (construir, instalar, compilar...);
  • Histórico do projeto: pelo que se passou até o projeto chegar na situação atual, o que motivou as decisões que foram tomadas, que decisões se mostraram "frustradas";
  • Como "usar" o projeto (com algo pronto, como realizar os procedimentos que proporcionam os resultados esperados no desenvolvimento do projeto);
  • Como aprender e ensinar sobre o projeto;
  • Como aprender e realizar coisas interessantes e atividades secundárias com uso do projeto;
  • Por que o projeto existe (objetivos, motivos e passos que o grupo se propõe);
  • Quais são as versões do projeto e porque elas existem;
Possíveis divisões da documentação:
  • Primeiros passos;
  • Sugestões de atividades com o projeto (antiga documentação de ensino). Aborda:
    • Oficinas
    • Atividades
    • Curiosidades
  • Como usar <o projeto>;
  • Como fizemos <o projeto> (desenvolvimento);
    • Testes
    • Versões
Ideias para próxima reunião:
  • Propostas de alteração da "documentação padrão";
  • Discussão da importância do Git;

Próxima reunião: 11/12/15

RE: Encontros elaboração oficinas de documentação - Added by Béuren Bechlin almost 5 years ago

Olá a todos e todas.

Estou dando início a discussão sobre o modelo padrão de repositório como também o cabeçalho padrão para fontes do CTA. Os cabeçalhos estão dentro da pasta Sources do repositório no padrao1.c e padrao2.c.
Criei um repositório para exemplificar o que estou comumente encontrando em repositório alheios. Então sugestões podem ser enviadas através de branch's do projeto com o seu nome.

Aqui está o link para encontrarem mais rapidamente:

https://git.cta.if.ufrgs.br/beuren/repositorioModelo/tree/master

(1-5/5)