Monday, March 11, 2013

Software Documentation Hierarchy


Disclaimer: kontent posting ini adalah opini dari penulis dan merupakan konten yang experimental, oleh karena itu sangat boleh untuk didebat dan penulis tidak diwajibkan untuk mempertahankannya.

Sewaktu melihat artikel wikipedia tentang software documentation, menurut Saya diperlukan konsep yang berbeda untuk kategorisasi dokumentasi software sebagai komplemen dari kategorisasi yang sudah dikemukakan di artikel tersebut. 

Konsep kategori pada artikel tersebut dibuat dari perspektif pengembangan, sehingga untuk situasi dan kondisi tertentu justu akan kontra-produktif. Misalnya, ada seorang programmer yang ingin mencari tau bagaimana cara install open source software X, kemudian dia mengambil dokumentasi mengenai arsitektur. Dia hanya akan dibombardir oleh informasi-informasi yang belum dia butuhkan, yang mungkin sekali akan membuatnya bingung.

Oleh karena itu, perlu dibuatkan lagi kategorisasi software documentation yang dirancang berdasarkan kebutuhan, situasi dan kondisi user, kategori tersebut yakni:
  1. Dokumentasi yang membuat pembaca bisa menggunakan software
  2. Dokumentasi yang membuat pembaca bisa meng-install software
  3. Dokumentasi yang membuat pembaca bisa mengkonfigurasi software
  4. Dokumentasi yang membuat pembaca bisa meng-compile/build software
  5. Dokumentasi yang membuat pembaca bisa mengembangkan software
Dengan kategorisasi diatas, dapat dilihat bahwa kategori tersebut merupakan konsep hirarki dokumentasi. Hirarki yang dibangun berdasarkan dependencies dari pengetahuan mengenai perangkat lunak tersebut dan kebutuhan user. Dengan begini, pembaca dokumentasi bisa mendapatkan gambaran mengenai informasi-informasi apa saja yang akan didapat sesuai dengan hirarkinya.

Terkait dengan kebutuhan project, perlu dianlisis terlebih dahulu sampai mana kebutuhan dokumentasi yang diperlukan, karena semakin dalam kebutuhan yang ada, akan semakin mahal membuatnya. Analisis ini dapat mempertimbangkan juga profil user project tersebut, apabila tidak ada programmer atau developer didalam jajaran user, maka hirarki Level 3 (Konfigurasi Software) adalah level terdalam yang masih efektif untuk dibuat.

3 comments:

  1. kalo menurut gw za, level 1,2,3 masuknya user manual. Kalo level 4 dan 5 baru masuknya kategori dokumentasi. *Sotoymode*

    ReplyDelete
    Replies
    1. itu bisa jadi cara kategorisasi lagi yang lain, bukannya 5 seperti post diatas, tapi 2 yakni user manual dan dokumentasi.

      Keuntungan 2 daripada 5 pastinya lebih simple. Yang perlu menjadi perhatian adalah infomasi yang terkandung di 2 kategori pasti lebih banyak informasi yang disajikan di masing-masing dokumen daripada kalo 5. Ini mungkin bisa jadi nilai plus ato minus tergantung situasi dan kondisi.

      Sedangkan keuntungannya dokumentasi 5 hirarki, pembaca bisa menentukan ingin menyelami dokumentasi sampai mana, tanpa kawatir mengakses informasi yang akan membingungkannya. So I still prefer 5 rather than 2

      Delete
  2. bisa kasi contoh gk dari permasing2 bagian itu, saya belum paham...tq

    ReplyDelete