Markdown: Essential Guide to Better Written Communication
Markdown: Essential Guide to Better Written Communication
Published 6/2024
Duration: 44m | .MP4 1280x720, 30 fps(r) | AAC, 44100 Hz, 2ch | 588 MB
Genre: eLearning | Language: English
Communicate professionally on GitHub README, Docs, Issues, Pull Requests, Discord and Slack
What you'll learn
Create Issues that contributors will want to collaborate on and maintainers will want to accept
Create Pull Requests that contributors will want to collaborate on and maintainers will want to accept.
Draft comments which make it easier for contributors and maintainers to review
Be confident in using Markdown
Requirements
No coding experience needed.
A GitHub account will be helpful.
Description
Markdown is very important for everyone in tech because it is used everywhere, from GitHub (such as in the README file to Issues and Pull Requests), Blog posts and Documentation. Therefore it is important that you have a good understanding of this language. This course will take you through everything you need to know to help you get your message across more clearly.
Why is Markdown important?
1. Written Communication: this is a vital skill which we need to keep improving, no matter what level we are at.
2. Collaboration: are your Issues, Comments, Pull Requests being ignored? It is probably because it is difficult for others to digest the content. Make it easier for them!
3. Reduce Noise: clear and concise messages reduce the need for prolonged conversations, and you can reach the end goal faster.
Here are some of the popular topics we will cover:
Code
We often need to include code blocks when writing an Issue, Comment or Pull Request. We can do this with syntax highlighting, diffs and other Markdown features to improve the reader's Developer Experience (DX).
Alerts
Highlight important information, such as warnings and instructions with these alert notices from GitHub's latest Markdown features.
Extras
With Markdown on GitHub you can annotate interactive maps, math equations and 3D models.
Who this course is for:
Developer, Tester, Project Manager, Technical Writer, DevOps.
Those in tech wanting to improve the format and styling of their written communication. For example: README, Documentation, Issues and Pull Requests, Discord and Slack.
Anyone in tech who is interested in working on a project on GitHub.
More Info
What you'll learn
Create Issues that contributors will want to collaborate on and maintainers will want to accept
Create Pull Requests that contributors will want to collaborate on and maintainers will want to accept.
Draft comments which make it easier for contributors and maintainers to review
Be confident in using Markdown
Requirements
No coding experience needed.
A GitHub account will be helpful.
Description
Markdown is very important for everyone in tech because it is used everywhere, from GitHub (such as in the README file to Issues and Pull Requests), Blog posts and Documentation. Therefore it is important that you have a good understanding of this language. This course will take you through everything you need to know to help you get your message across more clearly.
Why is Markdown important?
1. Written Communication: this is a vital skill which we need to keep improving, no matter what level we are at.
2. Collaboration: are your Issues, Comments, Pull Requests being ignored? It is probably because it is difficult for others to digest the content. Make it easier for them!
3. Reduce Noise: clear and concise messages reduce the need for prolonged conversations, and you can reach the end goal faster.
Here are some of the popular topics we will cover:
Code
We often need to include code blocks when writing an Issue, Comment or Pull Request. We can do this with syntax highlighting, diffs and other Markdown features to improve the reader's Developer Experience (DX).
Alerts
Highlight important information, such as warnings and instructions with these alert notices from GitHub's latest Markdown features.
Extras
With Markdown on GitHub you can annotate interactive maps, math equations and 3D models.
Who this course is for:
Developer, Tester, Project Manager, Technical Writer, DevOps.
Those in tech wanting to improve the format and styling of their written communication. For example: README, Documentation, Issues and Pull Requests, Discord and Slack.
Anyone in tech who is interested in working on a project on GitHub.
More Info
