[gangrena]

se não fosse javascript eu taria só dependente de wordpress, essa merda

esse mockup é tipo um adobe XD de la vida? é o que parece pelo o que eu pesquisei. UML eu já conhecia mas eu não sei usar... não faço ideia de como representar o fluxo do programa por UML sem deixar complicado com um molho de seta indo dum canto pro outro.

---

esse use case parece o mais simples pra representar uma estrutura funcional geral do software

---

atualmente eu tô escrevendo uma documentação freestyle em Markdown como se fosse um livro, eu não sei se é o modo "profissional" de fazer isso. Acho que fica de boa se eu integrar com use case, e quiçá uml (se eu conseguir manjar).

Documentação funcional ou de código?

Mockup é vc montar o software sem as funcionalidades, tipo só as telas em algum photoshop mas que não fazem nada, para ter uma noção de como funcionar.

Use case é de alto nível, documentar um software em uma linguagem "humana" e textual.

[JJaeger]

e tem diferença nas documentação, é?

eu achei use case simples pelo alta estirpe, coisa que uml não é

[gusyavoo]

alguém tem algumas dicas pra fazer uma documentação técnica de software? eu tô fazendo um projeto grande e tô com um pouco de dificuldade de codificar ele, pela dimensão, nessa hora que caiu a ficha "então é pra isso que serve a documentação..."

alguém manja? eu sinceramente sei de nada disso, não conheço padrões, técnicas, nem nada

Um requisito muito bem elaborado pra mim faz bem mais diferença que uma documentação técnica.
Além de que, documentação técnica pra mim é mais útil em um projeto com muitos desenvolvedores, tipo pelo menos mais de 10.

Agora a definição das dlls, software, etc que serão utilizados é bem importante.

[Aria-shachou]

uml (se eu conseguir manjar).

tem uns truques pra gerar o uml apartir do código... pelo menos em java dava pra fazer isso... se acha que eu ia fazer diagrama de fluxo? e etc? não dá não fica igual, acaba sempre mudando e atualizando as coisas.

Sobre documentação mesmo, existem as marcações que vc faz no código e depois pelo que sei é gerada a documentação certinha no fim, vc só precisa anotar e usar alguma api por ai e ser feliz.

[JJaeger]

Um requisito muito bem elaborado pra mim faz bem mais diferença que uma documentação técnica.
Além de que, documentação técnica pra mim é mais útil em um projeto com muitos desenvolvedores, tipo pelo menos mais de 10.

Agora a definição das dlls, software, etc que serão utilizados é bem importante.

eu penso em fazer documentação porque o software é grande demais, eu não tenho ideia do que ele deve ter ou como deve rodar (quantas classes, módulos deve ter, como deve correr o fluxo, etc), por isso eu preciso dum "esboço" dele antes, pra começar a programar já tendo essa estrutura em mãos. Mais ou menos um blueprint geral do software.

única coisa que me veio a mente foi uma "documentação técnica", o que eu conhecia de algo assim era uml, mas acho uml muito complicado de mecher, fora isso eu só pude pensar em imaginar todas as classes que eu teria e tentar dar funções a elas. 

mas tenho uma ideia geral já, eu pretendo pensar na estrutura funcional com uma diagrama use case, e especificar a parte técnica numa documentação de definição de classes/módulos/funções etc.

meu medo é estar fazendo as coisas no modo freestyle que só eu entenda, pois se possível eu queria usar algum padrão profissional pra quando eu precisar fazer algo parecido com uma equipe de devs, eles entendam a documentação, as famosas "boas práticas".

 não dá não fica igual, acaba sempre mudando e atualizando as coisas.

eu não curto uml, também, por causa disso. Por isso esse use case parece melhor pro meu caso.

Sobre documentação mesmo, existem as marcações que vc faz no código e depois pelo que sei é gerada a documentação certinha no fim, vc só precisa anotar e usar alguma api por ai e ser feliz.

eu já vi isso em frameworks, mas parece muito gambiarresco (deve precisar dum visual studio ou essas IDEs firulentas). For starters, eu quero só um padrão pra escrever documentação na mão mesmo.

[gusyavoo]

eu penso em fazer documentação porque o software é grande demais, eu não tenho ideia do que ele deve ter ou como deve rodar (quantas classes, módulos deve ter, como deve correr o fluxo, etc), por isso eu preciso dum "esboço" dele antes, pra começar a programar já tendo essa estrutura em mãos. Mais ou menos um blueprint geral do software.

única coisa que me veio a mente foi uma "documentação técnica", o que eu conhecia de algo assim era uml, mas acho uml muito complicado de mecher, fora isso eu só pude pensar em imaginar todas as classes que eu teria e tentar dar funções a elas. 

mas tenho uma ideia geral já, eu pretendo pensar na estrutura funcional com uma diagrama use case, e especificar a parte técnica numa documentação de definição de classes/módulos/funções etc.

meu medo é estar fazendo as coisas no modo freestyle que só eu entenda, pois se possível eu queria usar algum padrão profissional pra quando eu precisar fazer algo parecido com uma equipe de devs, eles entendam a documentação, as famosas "boas práticas".

Eu já passei por alguns sistemas grandes.
Pra mim de documentação o que é muito importante seria da arquitetura.

Os projetos, as camadas, negocio, como vai ser a comunicação, webapi ou wcf, framework de banco etc, a parte de validação, a interface.
Definindo isso, pra mim a outra coisa mais importante de documentação é o requisito.

Agora regra de código, documentação técnica de implementação tudo é muito fácil de controlar com integração continua e etc.

Mas assim, a parte mais importante é você ter isso escrito de forma clara, a ferramenta pra mim sempre foi o de menos.
A galera se empolga com as ferramentas, achando que vai mudar o mundo, mas não tem conteúdo nem pro básico ai não tem ferramenta que salve.

[gangrena]

e tem diferença nas documentação, é?

eu achei use case simples pelo alta estirpe, coisa que uml não é

Vc precisa saber o que vc quer documentar 

[JJaeger]

eu não manjo nada de wordpress, escolhi um tema e tô fazendo um site pro cliente a base de criar html estático e inserir como uma página no wordpress e adicionar o link pra ela no menu. E todo conteúdo dinâmico vou tentar inserir a base de shortcodes (que pode ser usado na parte de criar páginas/posts no wordpress) e chamadas ajax, nem o maior POG chega a esse nível de gambiarra.


tô usando react native pra fazer os aplicativo android e ios, a própria empresa que me contratou pediu pra eu usar. E tu escrevendo java na mão, @gangrena.

[gangrena]

eu não manjo nada de wordpress, escolhi um tema e tô fazendo um site pro cliente a base de criar html estático e inserir como uma página no wordpress e adicionar o link pra ela no menu. E todo conteúdo dinâmico vou tentar inserir a base de shortcodes (que pode ser usado na parte de criar páginas/posts no wordpress) e chamadas ajax, nem o maior POG chega a esse nível de gambiarra.


tô usando react native pra fazer os aplicativo android e ios, a própria empresa que me contratou pediu pra eu usar. E tu escrevendo java na mão, @gangrena.

Tenho pena da sua alma 

Alguma dia vc se libertara dos griloes do Javascritp e entenderá uma linguagem de verdade 

[JJaeger]

javascript é o fotoro

dá pra meter isso em qualquer coisa, é incrível. As coisa que eu não manjo de fazer no wordpress consigo fazer um workaround em javascript (com um pouco de php sujo posto no functions.php do wordpress)