Markdown & Documentation

Build practical foundations in Markdown & Documentation.

Start course →

Syllabus

Part 1

  1. Why documentation matters
  2. Markdown paragraph basics
  3. Headings and hierarchy
  4. Lists and emphasis
  5. Links and images

Part 2

  1. Code blocks and inline code
  2. Tables and blockquotes
  3. Task lists
  4. Front matter
  5. Previewing Markdown

Part 3

  1. Writing a useful README
  2. Installation instructions
  3. Usage examples
  4. Configuration reference
  5. Troubleshooting guides

Part 4

  1. API documentation
  2. Architecture decision records
  3. Changelogs
  4. Documentation for contributors
  5. Keeping docs current

Part 5

  1. Writing for your audience
  2. Accessible documentation
  3. Reviewing documentation
  4. Common documentation mistakes
  5. Documentation revision checklist