Better Programming

Advice for programmers.

Member-only story

Markdown Guide for Developers

7 min readMar 21, 2022

--

Photo made with Canva.

Have you ever tried to copy text out of a communication app, and it doesn’t format well in another text editor? Have you ever started to write your documentation in a word processor, migrate to a new platform, and it doesn’t adapt? In this article, we’ll learn how to improve our writing skills so we don’t fall into those traps.

What is Markdown?

Markdown is a powerful conversational tool for developers. Developers can use it to share their ideas across multiple applications easily, clearly, and in most cases platform-independent.

In this post, I will demonstrate how we communicate effectively with co-workers, using markdown. We can apply those strategies in a daily chat using Slack, Discord, or git repositories like GitHub, Bitbucket, or GitLab.

It is important to be clear and contribute with your ideas using well-written messages.

Git Repositories

We will start with some recommendations to use in your Git repositories.

Suggestion

--

--