Skip to content

hmbenicio/DevDocTemplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

211 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DevDocTemplate

DevDocTemplate é um repositório base para a criação e padronização da documentação de projetos.
Ele fornece uma estrutura clara e organizada para registrar todas as etapas, decisões e detalhes técnicos de um projeto, promovendo:

  • Transparência
  • Colaboração
  • Facilidade de manutenção

Este repositório tem como base a estrutura de documentação utilizada no curso de Análise e Desenvolvimento de Sistemas da PUC Minas Virtual, com adaptações feitas para uso em ambientes de trabalho e desenvolvimento reais.

HTML Linguagens e Tecnologias

  • Tabela organizada com as principais linguagens de programação, seus frameworks, bibliotecas e áreas de uso.
Ícone Linguagem Frameworks Bibliotecas Área de Uso
JavaScript JavaScript / TS React, Vue, Angular, Next.js, Express, NestJS Axios, Lodash, RxJS Front-end, Back-end, Full-stack Web
Python Python Django, Flask, FastAPI Pandas, NumPy, SciPy, TensorFlow, PyTorch, Matplotlib, Seaborn Web, APIs, Data Science, Machine Learning
Java Java Spring, Spring Boot, Hibernate, JSF, Android SDK, Jetpack Compose Jackson, Apache Commons, JUnit Web, Sistemas Corporativos, Mobile (Android)
CSharp C# (.NET) ASP.NET Core, Entity Framework, Unity, Blazor Newtonsoft.Json, AutoMapper, xUnit, MSTest Web, Jogos, Aplicações Desktop
PHP PHP Laravel, Symfony, CodeIgniter Composer, Guzzle, PHPUnit Web (especialmente back-end)
Ruby Ruby Ruby on Rails Nokogiri, RSpec, Devise Web (Desenvolvimento rápido)
Go Go (Golang) Gin, Echo, Fiber Gorilla Mux, GORM, Go Kit Web, Microserviços, APIs de Alta Performance
Kotlin Kotlin Ktor, Spring Boot kotlinx.coroutines, Exposed, Koin Mobile (Android), Back-end APIs

TÍTULO DO PROJETO

MERCADO

CATEGORIAS

RECURSOS

Descrição do Projeto

Forneça uma breve descrição do projeto em desenvolvimento, limitando-se a um ou dois parágrafos.

Equipe de desenvolvimento

  • Nome completo do desenvolvedor 1
  • Nome completo do desenvolvedor 2
  • Nome completo do desenvolvedor 3
  • Nome completo do desenvolvedor 4
  • Nome completo do desenvolvedor 5

Líder Técnico

  • Nome completo do líder técnico 1

Instruções de Utilização

Quando a primeira versão do sistema estiver disponível, esta seção deverá ser atualizada com as instruções detalhadas de uso.

Inclua orientações sobre:

  • Instalação de dependências necessárias;
  • Configuração do ambiente, se aplicável;
  • Passos para execução da aplicação (ex: comandos no terminal);
  • Qualquer outra informação relevante para o funcionamento correto do sistema.

Certifique-se de que as instruções sejam claras e possam ser seguidas por qualquer usuário, mesmo com conhecimento técnico básico.

Documentação

  1. Documentação de Contexto
  2. Especificação do Projeto
  3. Metodologia
  4. Projeto de Interface
  5. Arquitetura da Solução
  6. Template Padrão da Aplicação
  7. Programação de Funcionalidades
  8. Plano de Testes de Software
  9. Registro de Testes de Software
  10. Plano de Testes de Usabilidade
  11. Registro de Testes de Usabilidade
  12. Apresentação do Projeto
  13. Referências

Código

  • Código Fonte
  • Apresentação

  • Apresentação da solução
  • About

    DevDocTemplate é um repositório para criação e padronização de documentações, promovendo transparência, colaboração e manutenção. Baseado na metodologia do curso de ADS da PUC Minas Virtual, adaptado para uso profissional.

    Resources

    License

    Stars

    Watchers

    Forks

    Releases

    No releases published

    Packages

     
     
     

    Contributors