Skip to main content
Version: v1.1.0

Basic Tips

Let's discover the basics of pleasant and effective digital transformation in less than 5 minutes.

Version Control​

What is it?​

Version control is a way to keep track and manage changes to software code.

Why should I care?​

Version control can allow developer teams to keep track, mitigate, and resolve errors that may arise from code degradation or human error which leads to a more pleasant and effective digital transformation.

How to Implement?​

  1. Git: According to Stack Overflow's 2022 insights, Git is the de facto version control software that personal and professional developers use.
  2. Github: According to Stack Overflow's 2022 insights, Github is the most used version control platform that personal and professional developers use.

Documenting Code​

What is it?​

Documenting code is very important because it allows you and the rest of the development team to understand how your code works and is supposed to behave.

Why should I care?​

Documentation helps dev teams onboard new developers much faster and prevent information from being lost due to turnover or forgetting. This is applicable to all dev teams.

How to Implement?​

  1. Code Comments: Code comments are very helpful for developers because you can put the code documentation right next to the code. It is highly recommended to follow the documentation standard for your language that your dev team is using. If your language doesn't have a standard then it's important to be consistent with how you write your documentation.
  2. READMEs: READMEs are nice to explain higher level functionality of a program, function, class, or piece of software within an app or a piece of software that interacts with your dev team's app. READMEs can be included at any level of a Git repo, but generally recommended at the root or top level of a repo so that all developers will know where the README is.
  3. Wikis: Wikis are a good alternative to READMEs when you don't want to store high level documentation about your app inside a Git repo. According to Stack Overflow's 2022 insights, a very common wiki that dev teams use is Confluence