Cara menulis file .MD (Pragmatic: too Much vs too Few)
Cara menulis file .MD (Pragmatic: too Much vs too Few)
catatan: tulisan ini lebih teknis, sebagai implementasi renungan Menulis untuk ‘Future of Me’
Tulisan Umum
-
selalu gunakan
GIT History
untuk track changes - perhatikan cara menulis
Tulisan akan dibaca oleh manusia, maka sebaiknya menulis secaranatural.
Sebisa mungkin, menggunakan:- indentasi
- outline
Note: AI sangat cerdas dan langsung paham dengan mudah, tulisan yang dibuat secara
natural. - SDR:
- S {Situation → Specific → Simple → Speed → Shipment}
- D {Define → Document → Design → Develop → Delivery}
- R {Realistic → Refine → Result}
-
Too Few vs Too Much
❌ Too Few → Incomplete, tidak berguna ❌ Too Much → Overwhelmed, kebanjiran informasi ✅ Pragmaticsaya harus menemukan sweet spot – yang “pas”.
- jika memungkinkan, berisi 3 hal berikut:
{Nice to have, tetapi tidak harus selalu demikian, it can be boring}- Problem
- Solusi
- Ide Utama
## Problem and Solution
**Problem:**
- user ingin melakukan Import data ke suatu Software
- suatu Software mempunyai Format data khusus untuk masing-masing data
**Solusi:**
- tulisan `step by step` untuk melakukan Import data ke suatu Software
## Ide Utama: buat Data sesuai Format, file contoh dari suatu Software
- file Excel dari User
- `Contoh File` {_file Template Excel_} dari suatu Software
- Generate data (kombinasi)
Tulisan Teknis
Jika bagian di atas, lebih ke arah konsep, maka bagian berikut ini lebih ke actualnya. Saya banyak menulis artikel teknis di Website ini.
Saya gunakan beberapa pedoman berikut:
- the Pragmatic Programmer book
- Solve the problem
- not Perfectionist
- hindari
Over Engineering - Good > Perfect
- proses akhir:
- Shipment
- Delivery
- Result
- hindari
- CI / CD
- Continuous Improvement / Continuous Development
- bertahap
- terus menerus {Continuous}
- always gunakan GitHub untuk:
- menyimpan
Code - menyimpan tulisan-tulisan dalam bentuk .MD file
- GitHub Issues untuk menulis ide-ide yang terlintas {GitHub Issues support Versioning/History}
- copy/paste image ke file .MD atau ke Issue == sangat mudah
- menyimpan
- SDR:
- S {Situation → Specific → Simple → Speed → Shipment}
- D {Define → Document → Design → Develop → Delivery}
- R {Realistic → Refine → Result}
GOAL: untuk User / Client / Pembaca
Pada akhirnya, semua hal teknis diatas untuk satu tujuan:
sebuah Product/Content yang benar-benar berfungsi — untuk User/Client/Pembaca yang menggunakannya.
Itulah GOAL-nya.
Ketika ragu dalam mengambil keputusan, kembali ke GOAL tersebut.
Nice to know:
SDR - Software DevelopeR
SDR - SuDiRman
😁😁😁
he he he…