i-Educar
  • Home
  • Quem Usa?
  • Blog
  • Fórum
  • Documentação
  • Demonstração

›Documentação para Desenvolvedores

Documentação para Desenvolvedores

  • Home
  • Contribuindo com a documentação
  • Padrões de documentação
  • Começando a contribuir com a documentação

Contribuindo com a documentação do i-Educar

Veja como você pode contribuir com a documentação do projeto.

Documentações

O software tem em seu ecosistema três perfis de usuários, sendo Administrador, Usuário e Desenvolvedor. Para cada perfil de usuário será criado uma documentação específica.

Documentação para Administrador

O Administrador será o perfil que vai administrar o software, definindo regras de negócio e auxiliando os usuários finais, tendo uma figura próxima da Secretaria de Educação ou áreas similares.

Documentação para Usuário

Usuário tem o perfil de utilização mais vasto do software, com figuras como secretário de escola e professor.

Documentação de Desenvolvedor

Perfil de Desenvolvedor envolve pessoas com visão sistêmica, sejam com conhecimentos técnicos ou não, que possam apoiar na evolução do projeto.

Serão diversas vertentes, como Desenvolvimento, Documentação, API e outras. Os principais fatores envolvidos neste perfil de usuário, serão itens que apoiem a evolução do projeto.

Como contribuir

A documentação será feita utilizando o projeto Open Source Docusaurus, para facilitar construção, qualidade e diminuir a necessidade de conhecimentos técnicos.

O Docusaurus é um projeto criado pelo Facebook para ajudar a manter documentações de projetos Open Source, que está disponível em seu repositório no GitHub.

Comece a contribuir com a documentação: Começando a contribuir com a documentação

Padrões definidos

As definições tiveram como base a evolução do projeto, evitando obstáculos para isto.

  • Para cada perfil de usuário será criado um padrão de nomeação de arquivos
    • Administrador (admin-funcionalidade.md)
    • Usuário (user-funcionalidade.md)
    • Desenvolvedor (dev-funcionalidade.md)
  • Commits e Pull Requests serão realizados em Português (PT-BR)
← HomePadrões de documentação →
  • Documentações
    • Documentação para Administrador
    • Documentação para Usuário
    • Documentação de Desenvolvedor
  • Como contribuir
    • Padrões definidos
i-Educar
  • Home
  • Quem Usa?
  • Blog
  • Fórum
  • Documentação
  • Demonstração
  • Github

Mantido pela e Comunidade i-Educar para educação do Brasil

v. i-Educar