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

Padrões de documentação

Foram definidos alguns padrões para que a documentação possa evoluir colaborativamente.

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)
    • Infraestrutura (infra-[dev|prod|patch]-funcionalidade.md)
  • Commits e Pull Requests serão realizados em Português (PT-BR)

Ferramenta para documentação

Foi adotada uma ferramenta que tivesse alguns requisitos:

  • Código aberto
  • Boa aceitação pela comunidade
  • Usabilidade simplificada
  • Tecnologia simples
  • Versionamento da documentação, seguindo versões da aplicação

A ferramenta escolhida foi Docusaurus.

Vantagens do Docusaurus

  • Utiliza Markdown
  • Conversão do conteúdo Markdown para HTML estático
  • Construída em React (biblioteca JavaScript)
  • Boa aceitação da comunidade
  • Pública conteúdo estático diretamente no GitHub Pages (não há custos de infraestrutura tecnológica)
  • Versionamento da documentação, seguindo versões da aplicação
← Contribuindo com a documentaçãoComeçando a contribuir com a documentação →
  • Padrões definidos
  • Ferramenta para documentação
    • Vantagens do Docusaurus
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