Share
Embed
Create software for others to understand, machines understand binary
Juan Guillermo Gómez Torres
November 27, 2020
Transcript
23 slides
-
Juan Guillermo Gómez GDE Firebase & GCP @jggomezt Create software
for others to understand, machines understand binary -
JUAN GUILLERMO GÓMEZ Juan Guillermo es coorganizador de varios eventos,
como GDG Cali, Startup Weekend Colombia y software libre. Ha estado involucrado en la comunidad tecnológica durante los últimos 15 años. Asiste a más de 30 eventos al año como orador invitado en toda Latinoamérica, donde habla sobre móvil, android, cloud, firebase, kotlin, arquitectura de software, emprendimiento e innovación. Es reconocido por Google como un experto en Firebase y Google Cloud Platform. Actualmente es líder técnico de una startup en CDMX. @jggomezt youtube.com/devhack W. UTOPICODE.io linkedin.com/in/jggomezt -
Software Quality ❖ Software engineering process and methods used in
a project to ensure proper quality. ❖ Verify that quality attributes are achieved ❖ Verify that user requirements are met. -
Documentation Activities ➢ Communication Path ➢ Share Experiences ➢ A
way of teaching. ➢ Make better decisions -
Analysis Activities ➢ Requirements ➢ User Stories ➢ Wireframes. ➢
Mockups. ➢ Interviews. -
Design Activities ➢ Architecture ➢ Views. ➢ C4. ➢ UML.
➢ RFC. ➢ APIs - Open API -
Software Patterns ➢ Expert experiences ➢ Vocabulary ➢ Achieve quality
attributes ➢ Helps build complex architectures -
Clean Code Comments are usually created with the best of
intentions, when the author realizes that his or her code isn’t intuitive or obvious. In such cases, comments are like a deodorant masking the smell of fishy code that could be improved. https://refactoring.guru/es/smells/comments -
Code Smell - Comments The best comment is a good
name for a method or class. https://refactoring.guru/es/smells/comments -
Code Smell - Treatment If a comment is intended to
explain a complex expression, the expression should be split into understandable subexpressions using Extract Variable https://refactoring.guru/es/smells/comments -
Code Smell - Treatment If a comment explains a section
of code, this section can be turned into a separate method via Extract Method. The name of the new method can be taken from the comment text itself, most likely. https://refactoring.guru/es/smells/comments -
When to Ignore ❖ When explaining why something is being
implemented in a particular way. ❖ When explaining complex algorithms (when all other methods for simplifying the algorithm have been tried and come up short). ❖ When explaining solutions or algorithms of an article. ❖ When creating a library for others developers. https://refactoring.guru/es/smells/comments -
When creating a library for others developers ❖ Explain what
the method does. ❖ Explain how to use the methods. ❖ Explain the parameters and examples -
When creating a library for others developers ❖ Webpage with
the documentation. ❖ A readme document on Github. ❖ Software to document in each language -
Recommendations ❖ Just create the necessary documentation ❖ Share your
experiences with documentation ❖ Share solutions with the documentation. ❖ It is a great tool for learning. ❖ Clean code before anything else. -
References ❖ https://c4model.com/ ❖ https://swagger.io/ ❖ https://refactoring.guru/es/design-patterns ❖ https://refactoring.guru/es/refactoring/smells ❖
http://testlink.org/ ❖ https://www.sphinx-doc.org/en/master/ ❖ https://www.mantisbt.org/ ❖ https://trello.com/ -
Thank You! Gracias ! Juan Guillermo Gómez GDE Firebase &
GCP @jggomezt