Standar Dokumentasi
Panduan penulisan dokumentasi untuk Divisi IT — format, tools, dan best practices
Dokumentasi adalah salah satu fondasi utama Divisi IT. Bagian ini mencakup standar dan panduan yang harus diikuti oleh setiap anggota tim dalam menulis dokumentasi teknis.
Dokumen dalam Bagian Ini
- Standar Dokumentasi — Panduan lengkap menulis dokumentasi menggunakan Markdown, termasuk format frontmatter, struktur penulisan, dan contoh
- Diagram Arsitektur — Standar pembuatan diagram arsitektur menggunakan Mermaid, termasuk flowchart, sequence diagram, dan class diagram
Prinsip Penulisan
- Clear > clever — tulisan yang jelas lebih penting dari tulisan yang kelihatan pintar
- Show, don't just tell — sertakan contoh kode, screenshot, atau diagram
- Keep it current — dokumentasi yang outdated lebih buruk dari tidak ada dokumentasi
- One source of truth — jangan duplikasi informasi di banyak tempat