Menulis Dokumentasi untuk Data Pipeline
Apa yang perlu ada dalam dokumentasi?
Beberapa hari lepas, saya diminta untuk mengulas tentang sebuah dokumentasi teknikal. Dokumentasi tersebut digunakan untuk membantu data engineer lain memahami selok-belok sebuah laporan. Dokumentasi itu permulaan yang baik, dan berikut adalah ulasan dan cadangan saya untuk penambahbaikan.
Dengan menggunakan WH Questions, ia memandu kita menulis dokumentasi:
APA (WHAT) ?
Apakah definisi XXX ( Contohnya: Apakah definisi Pelanggan Berulang) ?
Apakah format report ini (CSV, Excel, Text File, API) ?
Apakah polisi pengekalan data (retention policy) ?
KENAPA (WHY) ?
Mengapa report ini perlu dihasilkan?
Mengapa pipeline ini perlu dibina secara XYZ?
SIAPA (WHO) ?
Siapakah pemegangtaruh (Stakeholder)?
Siapakah data owner?
Siapakah yang akan menggunakan report ini?
BILA (WHEN) ?
Bilakah report ini perlu disediakan?
Bilakah report ini perlu dihantar?
Bilakah tarikh akhir report ini perlu disediakan?
DI MANA (WHERE) ?
Di mana sumber data report ini?
Di mana destinasi report ini (email, ftp, S3) ?
BAGAIMANA (HOW) ?
Bagaimana report ini diproses
Bagaimana report ini dapat membantu syarikat
YANG MANA (WHICH) ?
Cara yang mana lebih selamat/jimat/pantas ?
Dengan menjawap soalan-soalan di atas anda dapat memahami keperluan report/data/pipeline secara menyeluruh dan dapat membantu anda menghasilkan dokumentasi yang lebih baik.
Nota kecil: Jika anda ada soalan-soalan yang dirasakan berkaitan mohon kongsikan di ruang komen.