photo-1422036306541-00138cae4dbc

Dokumentasi Software Menggunakan Dokumen Akses Publik

Setiap pengerjaan proyek perangkat lunak (yang baik), selalu menyertakan dokumentasi perangkat lunak sebagai deliverable-nya. Belakangan aku mencari-cari alternatif apakah gerangan yang bisa digunakan sebagai deliverable dokumentasi. Kriterianya adalah sebagai berikut:

  1. Memiliki word processing yang baik, sehingga tulisan bisa dihasilkan dengan tampilan yang indah dan rapi.
  2. Bisa diakses secara online, bukan hanya dokumen word atau pdf yang diberikan kepada klien begitu saja, tapi bisa diakses dari internet.
  3. Karena bisa diakes secara online, maka dibutuhkan manajemen permission yang baik.
  4. Bisa diembed ke dalam aplikasi.
  5. Bisa di-update sewaktu-waktu.

Untuk memenuhi kriteria tersebut, ada dua alternatif yang aku kira paling baik. Pertama adalah menggunakan blog, dan yang kedua adalah dengan menggunakan google docs atau word processor online lainnya. Perbedaan yang paling penting untuk dibahas dari kedua alternatif ini adalah bahwa jika menggunakan blog, misalnya wordpress, blogspot, dan sebagainya, maka dokumentasi akan dapat diakses secara umum dengan mudah. Kalau google docs, memang bisa diakses oleh publik, tapi URLnya keriting, sehingga membuat malas untuk mencari tahu.

Saat ini, aku akan memberikan gambaran untuk melakukan embed dokumentasi dari Google docs ke dalam aplikasi web kita (Menggunakan blog juga sama caranya).

Buat Dulu Dokumentasinya

Ya iyalah ya. Langkah pertama dan yang paling utama di sini adalah buat yakinkan dulu dokumentasinya sudah dibuat. Minimal dokumen kosong di google docs. Misalnya seperti di bawah ini.

konten dokumentasi.png

Oya, dengan menggunakan google docs, terdapat fitur daftar isi yang dapat dihasilkan secara otomatis, jadi bisa lebih memudahkan pembuatan dokumen.

Publish to the Web

Langkah selanjutnya adalah dengan melakukan publikasi. Hal ini dapat dilakukan pada menu File > Publish to the web… (iya, itu memang ada titiknya tiga, gapapa).

publish to the web.png

Kemudian muncullah sebuah kotak dialog yang memberikan pilihan untuk melakukan publikasi. Pilihlah “publish”. Di bawahnya, ada pilihan untuk menghentikan publikasi, dan kotak centang (kota centang? Apa ya nama Indonesianya untuk checkbox?). Setelah melakukan publikasi, barulah muncul link yang berisi hasil publikasi dokumen kita. Di sebelah tab Link, terdapat tab Embed yang berfungsi untuk melekatkan konten dokumen kita di sebuah aplikasi lain. Skrip yang terdapat dalam tab Embed inilah yang akan kita gunakan, skrip ini berupa iframe.

Siapkan Halamn Help dalam Aplikasi

Dalam aplikasi yang kita buat, siapkan sebuah halaman berupa help atau sejenisnya. Isikan kontennya dengan iframe Embed yang telah dijelaskan sebelumnya. Kira-kira beginilah skrip pada halaman help itu.

<html>
<head>
<style type=”text/css”>
body, html {
margin: 0; padding: 0; height: 100%; overflow: hidden;
}

#content {
position:absolute; left: 0; right: 0; bottom: 0; top: 0px;
}
</style>
</head>
<body>

<!– Paste iframe di sini –>

</body>
</html>

Skrip css tersebut memerintahkan browser untuk menampilkan iframe yang dilekatkan secara full page. Kurang lebih hasilnya sebagai berikut.
preview.png
Jadi, dengan begini, pengarsipan dokumen jadi lebih terpusat di dalam google drive, dan ketika ada perubahan konten dapat dilakukan dari google docs dan langsung dipublikasikan di web.

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s