Implementasi Docs-Indexing pada Dokumentasi Warung Pintar

Muhammad Rafly Andrianza
Grow at Warung Pintar
3 min readJul 26, 2022
Warung Pintar — Implementasi Docs Indexing

Bila kamu melihat dokumentasi yang terlalu sudah padat dan teracak pasti kamu akan bingung, bukan?. Contohnya seperti dibawah ini:

Before Docs-Indexing

Seperti yang kita ketahui, Dokumentasi merupakan hal terpenting yang ada sebagai panduan referensi informasi yang dapat membantu kita untuk melihat sesuatu dalam bentuk konteks bacaan. Di sisi lain, ketika dokumentasi kita terlalu banyak, kita akan kesulitan untuk melakukan perbaikan ataupun pemeliharaan daripada dokumentasi itu sendiri. Maka dari itu, Technical Writer Squad dari Warung Pintar berupaya untuk menerapkan metode Johnny.Decimal, yaitu metode sistematis untuk mengatur dan mengorganisasikan urutan dokumentasi.

Johnny.Decimal number

Menerapkan Johnny.Decimal

Untuk menggunakan Johnny.Decimal kamu dapat mengakses melalui https://johnnydecimal.com/ dan nantinya kamu akan diarahkan bagaimana sih caranya agar kamu dapat membuat struktur urutan penomoran dokumentasi yang tepat, seperti contoh penerapan Johnny.Decimal untuk dokumentasi Warung Pintar dibawah ini:

After Docs-Indexing

Metode ini GRATIS dan dapat digunakan oleh SIAPAPUN, caranya sangat mudah kamu pertama-tama hanya perlu:

Tahap pertama: Membagi semuanya kategori yang kamu miliki menjadi sepuluh hal!

  1. Tentukan apa saja yang kamu butuhkan untuk diorganisir dan urutkan ke dalam setidaknya 10 kategori.
  2. Pastikan antar kategori nya jelas berbeda.
  3. Beri label pada setiap kategori.
  • Tahap ini akan memaksa kamu untuk mengkategorikan berbagai hal secara luas, tetapi itulah intinya.
  • Kami menyebut kategori ini sebagai area kamu. Suatu area yang kita contohkan mungkin seperti “Finance”.

Tahap kedua: Di setiap area, bagi menjadi sepuluh sub-kategori lagi!

  • Telusuri setiap kategori dan ulangi prosesnya. Ini akan membuat kategori kamu lebih sesuai.
  • Kategori dalam area “Finance” mungkin berkaitan dengan sub-kategori “Tax returns” sebagai contohnya.
  • Sekarang kamu akan memiliki sepuluh area yang masing-masing berisi sepuluh kategori. Dan Johnny.Decimal memiliki batasan sampai dengan yang paling banyak adalah 100 kategori. Tetapi tidak perlu khawatir karena sangat tidak mungkin kamu akan memiliki seratus kategori, bukan? (kecuali perusahaan kamu benar-benar memiliki pengkategorian dokumentasi yang sangat banyak diatas 100).
An example case of Johnny.Decimal

Kesimpulan

Jadi Johnny.Decimal ini akan membantu kamu untuk dapat mengatur urutan dokumentasi dengan lebih terstruktur menggunakan prinsip penomoran.

Itulah sedikit yang bisa kita sampaikan bagaimana caranya agar kamu dapat mengorgansisasikan dokumentasi kamu. Harapannya semoga teman-teman yang membaca dapat mengimplementasi di masing-masing lingkungan kerja dan membantu efisiensi kinerja pencarian dokumentasi.

Bagaimana? Sudah cukup jelas? Kalau ada pertanyaan, silakan sampaikan langsung pertanyaan di comment, ya!

Sumber:

--

--

Muhammad Rafly Andrianza
Grow at Warung Pintar
0 Followers

Technical Writer, Startup Founder, & Project Freelancer.