adicionar documentação do jogo

ghost commented 1 year ago

Olá MarkusLuan.

Penso em adicionar documentação do jogo, desse modo alguns desenvolvedores podem extender determinadas funcionalidades ou acrescentar mais recursos. Antes de fazer essa ideia, gostaria de saber se você sente o mesmo ou gostaria de adicionar documentação no jogo ou não.

atualização: Você pode encontrar essa implementação aqui: github/MarkusLuan/M-Attack-jsWeb/pull/12

espero uma resposta sobre essa issue para adicionar um possivelmente pull-request oficial. o que pensa dessa ideia faz sentido ou não?

MarkusLuan commented 1 year ago

Opa, mano. Qual seria a diferença do README.md para a documentação?

E desculpa a demora em dar um feedback, essa semana está bem corrida..... Estou apertado com os estudos e outros projetos que estou fazendo para alguns clientes.

ghost commented 1 year ago

Oi MarkusLuan.

Opa, mano. Qual seria a diferença do README.md para a documentação?

O read-me é apenas uma forma simplificada de você falar do projeto. Uma documentação fala sobre o processo de desenvolvimento, o algoritmo. Geralmente numa documentação técnica você sabe todas as informações sobre o software ou algoritmo. Isso é importante caso os desenvolvedores queiram utilizar essa informação para desenvolver uma versão do software.
De modo geral, documentação é bem mais completa do que um readme e inclui muito mais informação. E por boa prática, é aconselhável utilizar uma documentação e mais um read-me.
Além disso, se o software estiver bem documentado fica fácil para divulgar e implementar novas versões, modificações etc. O que é interessante caso queira que mais pessoas utilizem, modifiquem e melhorem ou aprimorem o jogo.
Inicialmente penso em fazer uma página no GitHub pages com docsify que é um framework feito apenas para criar documentação técnica. Isso é interessante para unir duas comunidades em algo interessante, único.

E desculpa a demora em dar um feedback, essa semana está bem corrida..... Estou apertado com os estudos e outros projetos que estou fazendo para alguns clientes.

valeu pelo feedback.

MarkusLuan commented 1 year ago

Desculpa a demora mais uma vez.... Mas acabei de aprovar o pull-request. Valeu meu amigo, um abraço. E que Deus te recompense poderosamente.

MarkusLuan / M-Attack-jsWeb

adicionar documentação do jogo #10