Getting Started¶
👋 Welcome¶
Selamat datang di bagian Standards.
Bagian ini berisi seluruh pedoman yang digunakan dalam menyusun dokumentasi pada DevOps Engineering Handbook.
Sebelum membuat project baru atau menambahkan dokumentasi baru, disarankan untuk memahami standar yang digunakan agar seluruh dokumentasi memiliki struktur, gaya penulisan, dan workflow yang konsisten.
Standards tidak menjelaskan implementasi suatu teknologi, melainkan menjelaskan bagaimana dokumentasi disusun dan dikelola.
❓ Why Standards?¶
Seiring bertambahnya jumlah project, dokumentasi tanpa standar akan menjadi sulit dipelihara dan cenderung memiliki struktur yang tidak konsisten.
Dengan adanya standards, setiap project menggunakan pendekatan yang sama sehingga dokumentasi menjadi:
- Lebih mudah dipelajari.
- Lebih mudah direview.
- Lebih mudah dipelihara.
- Lebih mudah dikembangkan.
📚 Scope¶
Standards pada handbook ini dibagi ke dalam beberapa area utama.
| Area | Description |
|---|---|
| Engineering Principles | Prinsip engineering yang menjadi dasar penyusunan dokumentasi. |
| Documentation Standards | Aturan umum mengenai struktur, organisasi, dan hubungan antar dokumentasi. |
| Engineering Journal Standards | Standar pencatatan perjalanan engineering dan Technical Note. |
| Project Standards | Standar struktur dokumentasi untuk setiap project. |
| Writing Standards | Pedoman gaya penulisan dokumentasi. |
| Workflow Standards | Workflow penyusunan dan pemeliharaan dokumentasi. |
🧭 Recommended Reading Order¶
Untuk memperoleh pemahaman yang utuh, bacalah dokumentasi dengan urutan berikut.
- Engineering Principles
- Documentation Standards
- Engineering Journal Standards
- Project Standards
- Writing Standards
- Workflow Standards
Urutan tersebut membantu memahami prinsip dasar sebelum mulai membuat atau memperbarui dokumentasi.
🚀 Next Step¶
Setelah memahami bagian Getting Started, lanjutkan ke Engineering Principles untuk mempelajari prinsip-prinsip engineering yang menjadi dasar penyusunan seluruh dokumentasi pada DevOps Engineering Handbook.