How to write a .MD file

note: this article is more technical, as a practical implementation of the reflection Writing for ‘Future of Me’

General Writing

  1. always use GIT History
    to track changes

  2. pay attention to how you write
    Writing is read by humans, so write naturally. - Indentation - Outline

Note: AI is very smart and understands natural writing immediately and easily.

  1. SDR:
    • Situation
    • D {Define → Design → Document → Develop → Delivery}
    • R {Result, Realistic}
  2. Too Few vs Too Much
    ❌ Too Few   → Incomplete, not useful
    ❌ Too Much  → Overwhelmed, information overload
    ✅ Pragmatic
  1. where possible, include these 3 things:
    {Nice to have, but not always required — it can be boring}
    1. Problem
    2. Solution
    3. Main Idea
## Problem and Solution

**Problem:**
- user wants to import data into Accurate
- Accurate has its own specific data format for each type of data

**Solution:**
- a step-by-step guide for importing data into Accurate

## Main Idea: prepare data in the correct Format, using Accurate's sample file
- Excel file from the User
- `Sample File` {_Excel Template file_} from Accurate
- Generate data (combination)

Technical Writing

Philosophy:

  1. the Pragmatic Programmer book
  2. Solve the problem
  3. Not Perfectionist
    • avoid Over Engineering
    • Good > Perfect
    • Shipment {Delivery} the Result {writing, Code, …}
  4. CI / CD
    • Continuous Improvement / Continuous Development
    • step by step
    • continuously {Continuous}
  5. SDR:
    • Situation
    • D {Define → Design → Document → Develop → Delivery}
    • R {Result, Realistic}