Tag Archives: DESIGN DOC

MARKDOWN FILES

#16 MARKDOWN FILES

Example of my style of MARKDOWN design document.

Many people are familiar with project collaboration apps such as Trello, Slack or KanbanFlow. These platforms are great for discussing projects and planing results + steps etc. However every application needs a design document. This is where markdown comes into play. Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform. Although you can use any other document format such as MS Words .docx or .xls etc. Markdown is my preferred documentation syntax.

A good README.md will have the following features:

https://www.markdownguide.org/basic-syntax/