Menu
Pasang iklan SEO disini Murah, 300.000/6 Bulan dan dapatkan Trafik setiap harinya

Membuat Dokumen Teknis TIK.PR02.018.01

May
28
2015
by : Bupeko. Posted in : blog

 

MATERI PELATIHAN BERBASIS KOMPETENSI

SEKTOR TEKNOLOGI INFORMASI DAN KOMUNIKASI

 

 

 

 

 

 

MEMBUAT DOKUMEN TEKNIS

TIK.PR02.018.01

 

 

 

 

 

 

 

BUKU INFORMASI

 

 

 

 

 

 

 

DEPARTEMEN TENAGA KERJA DAN TRANSMIGRASI R.I.

DIREKTORAT JENDERAL PEMBINAAN PELATIHAN DAN PRODUKTIVITAS

Jl. Jend. Gatot Subroto Kav.51 Lt.7.B Jakarta Selatan

 

 

DAFTAR ISI

 

DAFTAR ISI. 1

BAB I. 3

PENGANTAR. 3

1.1     Konsep Dasar Competency Based Training (CBT) 3

1.2     Penjelasan Modul 3

1.2.1      Desain Modul 3

1.2.2      Isi Modul 3

1.2.3      Pelaksanaan Modul 4

1.3         Pengakuan Kompetensi Terkini (RCC) 4

1.4         Pengertian-Pengertian / Istilah  5

BAB II. 7

STANDAR KOMPETENSI. 7

2.1     Peta Paket Pelatihan. 7

2.2     Pengertian Unit Standar Kompetensi 7

2.3     Unit Kompetensi Yang Dipelajari 7

2.3.1 Judul Unit Kompetensi 8

2.3.2 Judul Unit Kompetensi 8

2.3.3 Deskripsi Unit 8

2.3.4 Elemen Kompetensi 8

2.3.5 Batasan Variabel 9

2.3.6 Panduan Penilaian  9

2.3.7 Kompetensi Kunci 11

BAB III. 12

STRATEGI DAN METODE PELATIHAN. 12

3.1     Strategi Pelatihan. 12

3.2     Metode Pelatihan. 13

BAB IV. 14

MATERI UNIT KOMPETENSI. 14

4.1 Tujuan Instruksional Umum.. 14

4.2 Tujuan Instruksional Khusus 14

4.3     Uraian Singkat Materi 14

4.4     Beberapa Pengertian dalam Unit Kompetensi Ini : 15

4.5     Informasi masing-masing elemen kompetensi: 15

4.5.1 Mengidentifikasi data untuk kebutuhan dokumen teknis 15

4.5.2 Merencanakan pembuatan dokumen teknis 20

4.5.3 Membuat/menulis dokumen teknis 30

4.5.4 Mengevaluasi dokumen teknis 35

BAB V. 41

SUMBER-SUMBER YANG DIPERLUKAN UNTUK PENCAPAIAN                          KOMPETENSI  41

5.1 Sumber Daya Manusia. 41

5.2 Sumber-sumber Kepustakaan ( Buku Informasi ) 42

5.3     Daftar Peralatan dan Bahan yang digunakan. 42

DAFTAR PUSTAKA. 44

 


BAB I

PENGANTAR

 

1.1        Konsep Dasar Competency Based Training (CBT)

 

  • Apakah pelatihan berdasarkan kompetensi?

Pelatihan berdasarkan kompetensi adalah pelatihan yang memperhatikan pengetahuan, keterampilan dan sikap yang diperlukan di tempat kerja agar dapat melakukan pekerjaan dengan kompeten. Standar Kompetensi dijelaskan oleh Kriteria Unjuk Kerja.

 

  • Apakah artinya menjadi kompeten ditempat kerja?

Jika anda kompeten dalam pekerjaan tertentu, anda memiliki seluruh keterampilan, pengetahuan dan sikap yang perlu untuk ditampilkan secara efektif ditempat kerja, sesuai dengan standar yang telah disetujui.

 

1.2        Penjelasan Modul

Pada bagian ini akan dijelaskan tentang desain modul, isi modul, dan pelaksanaan modul.

1.2.1    Desain Modul

Modul ini didesain untuk dapat digunakan pada Pelatihan Klasikal dan Pelatihan Individual / mandiri :

  • Pelatihan klasikal adalah pelatihan yang disampaikan oleh seorang pelatih.
  • Pelatihan individual / mandiri adalah pelatihan yang dilaksanakan oleh peserta dengan menambahkan unsur-unsur / sumber-sumber yang diperlukan dengan bantuan dari pelatih.

1.2.2    Isi Modul

Bagian Isi Modul ini menerangkan tentang Buku Informasi, Buku Kerja, dan Buku Penilaian.

 

Buku Informasi

Buku informasi ini adalah sumber pelatihan untuk pelatih maupun peserta pelatihan. Buku ini digunakan sebagai panduan untuk peserta pelatihan.

 

 

Buku Kerja

Buku kerja ini harus digunakan oleh peserta pelatihan untuk mencatat setiap pertanyaan dan kegiatan praktek baik dalam Pelatihan Klasikal maupun Pelatihan Individual / mandiri.

Buku ini diberikan kepada peserta pelatihan dan berisi :

  • Kegiatan-kegiatan yang akan membantu peserta pelatihan untuk mempelajari dan memahami informasi.
  • Kegiatan pemeriksaan yang digunakan untuk memonitor pencapaian keterampilan peserta pelatihan.
  • Kegiatan penilaian untuk menilai kemampuan peserta pelatihan dalam melaksanakan praktik kerja.

 

Buku Penilaian

Buku penilaian ini digunakan oleh pelatih untuk menilai jawaban dan tanggapan peserta pelatihan pada buku kerja dan berisi :

  • Kegiatan-kegiatan yang dilakukan oleh peserta pelatihan sebagai pernyataan keterampilan.
  • Metode-metode yang disarankan dalam proses penilaian keterampilan peserta pelatihan.
  • Sumber-sumber yang digunakan oleh peserta pelatihan untuk mencapai keterampilan.
  • Semua jawaban pada setiap pertanyaan yang diisikan pada buku kerja.
  • Petunjuk bagi pelatih untuk menilai setiap kegiatan praktik.
  • Catatan pencapaian keterampilan peserta pelatihan.

 

1.2.3    Pelaksanaan Modul

Pada pelatihan klasikal, pelatih akan :

  • Menyediakan buku informasi yang dapat digunakan peserta pelatihan sebagai sumber pelatihan.
  • Menyediakan salinan buku kerja kepada setiap peserta pelatihan.
    • Menggunakan buku informasi  sebagai sumber utama dalam penyelenggaraan pelatihan.
    • Memastikan setiap peserta pelatihan memberikan jawaban / tanggapan dan menuliskan hasil tugas praktiknya pada buku kerja.

 

Pada Pelatihan individual / mandiri, peserta pelatihan akan :

  • Menggunakan buku informasi sebagai sumber utama pelatihan.
  • Menyelesaikan setiap kegiatan yang terdapat pada buku kerja.
  • Memberikan jawaban pada buku kerja.
  • Mengisikan hasil tugas praktik pada buku kerja.
  • Memiliki tanggapan-tanggapan dan hasil penilaian oleh pelatih.

 

1.3        Pengakuan Kompetensi Terkini (RCC)

 

  • Apakah Pengakuan Kompetensi Terkini (Recognition of Current Competency)

Jika anda telah memiliki pengetahuan dan keterampilan yang diperlukan untuk elemen unit kompetensi tertentu, anda dapat mengajukan pengakuan kompetensi terkini (RCC). Berarti anda tidak akan dipersyaratkan untuk belajar kembali.

 

  • Anda mungkin sudah memiliki pengetahuan dan keterampilan, karena anda telah :
  1. Bekerja dalam suatu pekerjaan yang memerlukan suatu pengetahuan dan keterampilan yang sama atau
  2. Berpartisipasi dalam pelatihan yang mempelajari kompetensi yang sama atau
  3. Mempunyai pengalaman lainnya yang mengajarkan pengetahuan dan keterampilan yang sama.

 

1.4        Pengertian-Pengertian / Istilah

 

Profesi

Profesi adalah suatu bidang pekerjaan yang menuntut sikap, pengetahuan serta keterampilan/keahlian kerja tertentu yang diperoleh dari proses pendidikan, pelatihan serta pengalaman kerja atau penguasaan sekumpulan kompetensi tertentu yang dituntut oleh suatu pekerjaan/jabatan.

 

Standardisasi

Standardisasi adalah proses merumuskan, menetapkan serta menerapkan suatu standar tertentu.

 

Penilaian / Uji Kompetensi

Penilaian atau Uji Kompetensi adalah proses pengumpulan bukti melalui perencanaan, pelaksanaan dan peninjauan ulang (review) penilaian serta keputusan mengenai apakah kompetensi sudah tercapai dengan membandingkan bukti-bukti yang dikumpulkan terhadap standar yang dipersyaratkan.

 

Pelatihan

Pelatihan adalah proses pembelajaran yang dilaksanakan untuk mencapai suatu kompetensi tertentu dimana materi, metode dan fasilitas pelatihan serta lingkungan belajar yang ada terfokus kepada pencapaian unjuk kerja pada kompetensi yang dipelajari.

 

Kompetensi Kerja

Kompetensi  Kerja adalah kemampuan kerja setiap individu  yang mencakup aspek  pengetahuan ,  keterampilan dan sikap kerja  yang sesuai dengan standar yang ditetapkan

 

Pelatihan Berbasis Kompetensi Kerja.

Pelatihan Berbasisi Kompetensi Kerja adalah  pelatihan kerja yang menitikberatkan pada penguasaan kemampuan kerja yang mencakup pengetahuan, keterampilan dan sikap sesuai dengan standar yang ditetapkan dan persyaratan di tempat kerja.

 

Standar Kompetensi Kerja Nasional Indonesia

Standar Kompetensi Kerja Nasional Indonesia adalah rumusan kemampuan kerja yang mencakup aspek pengetahuan, keterampilan dan / atau keahlian serta sikap kerja yang relevan dengan pelksanaan tugas dan syarat jabatan yang ditetapkan sesuai dengan ketentuan peraturan perundang-undangan yang berlaku.

 

Sertifikasi Kompetensi Kerja.

Sertifikasi kompetensi Kerja adalah proses pemberian sertifikat kompetensi yang

dilakukan secara sitematis dan obyektif melalui uji kompetensi sesuai standar kompetensi kerja nasional Indonesia, standar internasional dan /atau standar khusus.

Sertifikat Kompetensi Kerja

Sertifikat Kompetensi Kerja adalah bukti tertulis yang diterbitkan oleh lembaga sertifikasi profesi terakreditasi yang menerangkan bahwa seseorang telah menguasai kompetensi kerja tertentu sesuai dengan SKKNI.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


BAB II

STANDAR KOMPETENSI

 

2.1        Peta Paket Pelatihan

Modul yang sedang Anda pelajari ini bertujuan untuk mencapai satu unit kompetensi. Adapun kompetensi ini termasuk dalam satu paket pelatihan, yang terdiri atas unit-unit kompetensi berikut:

  1. TIK.PR02.018.01       Membuat Dokumen Teknis

 

2.2        Pengertian Unit Standar Kompetensi

 

Apakah Standar Kompetensi?

Setiap Standar Kompetensi menentukan :

  1. Pengetahuan dan keterampilan yang diperlukan untuk mencapai kompetensi.
  2. Standar yang diperlukan untuk mendemonstrasikan kompetensi.
  3. Kondisi dimana kompetensi dicapai.

 

Apakah yang akan anda pelajari dari Unit Kompetensi ini ?

Di dalam unit kompetensi ini, Anda akan mempelajari bagaimana caranya menulis sebuah dokumen teknis.

 

Berapa lama unit kompetensi ini dapat diselesaikan ?

Sistem pelatihan berbasis kompetensi terfokus pada pencapaian kompetensi, bukan pada lamanya waktu. Namun diharapkan pelatihan ini dapat dilaksanakan dan dicapai dalam jangka waktu tidak lebih dari seminggu, tiga sampai lima hari.

 

Berapa banyak/kesempatan yang anda miliki untuk mencapai kompetensi ?

Jika Anda belum mencapai kompetensi pada usaha/kesempatan pertama, Pelatih Anda akan mengatur rencana pelatihan dengan Anda. Rencana ini akan memberikan Anda kesempatan kembali untuk meningkatkan level kompetensi Anda sesuai dengan level yang diperlukan. Jumlah maksimum usaha/kesempatan yang disarankan adalah 3 (tiga) kali.

 

2.3        Unit Kompetensi Yang Dipelajari

Dalam sistem pelatihan Standar Kompetensi diharapkan menjadi panduan bagi peserta pelatihan untuk dapat :

  1. Mengidentifikasikan apa yang harus dikerjakan peserta pelatihan.
  2. Memeriksa kemajuan peserta pelatihan.
  3. Menyakinkan bahwa semua elemen (sub-kompetensi) dan kriteria unjuk   kerja telah dimasukkan dalam pelatihan dan penilaian.

2.3.1 Judul Unit Kompetensi

Kode Unit               : Membuat Dokumen Teknis

 

2.3.2 Judul Unit Kompetensi

Judul Unit               : TIK.PR02.018.01

2.3.3 Deskripsi Unit

Unit ini menentukan kompetensi yang diperlukan untuk menulis atau membuat pekerjaan teknis setelah kode program siap untuk diinstal. Dokumen teknis yang dibuat adalah dokumen petunjuk instalasi program (manual instalasi). Unit ini akan membahas tentang mengidentifikasi data untuk kebutuhan dokumen teknis, merencanakan pembuatan dokumen teknis, membuat/menulis dokumen teknis, dan mengevaluasi dokumen teknis.

2.3.4 Elemen Kompetensi

Elemen Kompetensi

Kriteria Unjuk Kerja

1.  Mengidentifikasi data untuk kebutuhan dokumen teknis 1.1  Dokumen teknis diidentifikasi sesuai kebutuhan.

1.2  Kebutuhan informasi sesuai dengan layout dan standar dokumen yang diacu.

1.3  Template dan petunjuk penulisan disiapkan. Format dokumen dan petunjuk penulisan dokumen telah diketahui.

1.4  Lingkupan pekerjaan sesuai dengan batasan waktu, teknologi yang digunakan dan sumber daya yang akan dipakai digunakan untuk penyusunan dokumen tersebut.

2.  Merencanakan pembuatan dokumen teknis 2.1  Data yang relevan dengan isi dokumen teknis diidentifikasi.

2.2  Isi dokumen teknis sesuai dengan lingkup dan standar dokumen yang digunakan.

2.3  Struktur dokumen dibuat atas dasar aliran informasi dan standar dokumen yang digunakan.

3. Membuat/menulis dokumen teknis 3.1  Isi dokumen teknis dibuat sesuai dengan struktur dokumen.

3.2  Format dokumen dibuat sesuai dengan standar yang dipakai.

3.3  Penulis dokumen dibuat sesuai kaidah bahasa yang benar.

4. Mengevaluasi dokumen teknis 4.1  Dokumen direvisi atas dasar standar dokumen dan aliran informasi.

4.2  Dokumen dikoreksi sebagai jaminan bagi kesempurnaan teknis dan tata bahasa.

4.3  Dokumen dilengkapi agar terpenuhinya kebutuhan dokumen teknis.

4.4  Dokumen dipublikasikan agar terpenuhinya kebutuhan pengguna.

Tabel 1 Elemen Kompetensi

2.3.5 Batasan Variabel

Batasan variabel dalam bahasan ini adalah:

  1. Unit ini berlaku untuk sektor Teknologi Informasi dan Komunikasi.
  2. Membuat dokumen teknis bersifat internal pada bidang teknologi informasi dan komunikasi.

 

2.3.6 Panduan Penilaian

 

  1. 1.   Pengetahuan dan keterampilan penunjang untuk mendemontrasikan kompetensi, diperlukan bukti keterampilan dan pengetahuan di bidang:

Untuk mendemontrasikan kompetensi, memerlukan bukti keterampilan dan pengetahuan di bidang berikut ini :

 

1.1 Pengetahuan dasar:

1.1.1     Mengidentifikasi metode pengembangan sistem.

1.1.2     Mengidentifikasi spesifikasi sistem.

1.1.3     Mengidentifikasi bahasa pemrograman yang dipakai.

1.1.4     Mengidentifikasi standar dokumen yang dipakai.

1.1.5     Standar unjuk kerja.

 

2. Konteks penilaian

Unit ini dapat di nilai di dalam tempat kerja atau tempat lain secara praktek komputer dengan kondisi kerja sesuai dengan keadaan normal. Penilaian diluar pekerjaan harus dilaksanakan dalam suatu lingkungan kerja yang disimulasikan mendekati pekerjaan yang semestinya.

Penilaian mungkin menggabungkan serangkaian metode untuk menilai kemampuan dan penerapan pengetahuan pendukung penting, dan mungkin mencakup:

2.1     Demontrasi praktis (pengamatan langsung harus terjadi lebih dari sekali untuk menentukan konsistensi kemampuan).

2.2 Studi kasus.

2.3 Contoh-contoh kerja atau kegiatan-kegiatan simulasi kerja.

2.4 Menanyakan secara lisan/interview.

2.5 Proyek/laporan/buku catatan kemajuan.

2.6 Laporan pihak ketiga dan prestasi otentik sebelumnya.

2.7 Bukti penilaian.

 

3.  Aspek penting penilaian

Aspek yang harus diperhatikan :

3.1.  Kemampuan perencanaan pembuatan dokumen teknis yang sesuai dengan lingkup dan standar dokumen yang dibuat.

3.2.   Kemampuan menulis dokumen teknis.

3.3.   Kemampuan mengevaluasi dokumen teknis.

 

4.  Kaitan dengan unit-unit lainnya

4.1 Unit ini didukung oleh pengetahuan dan keterampilan dalam unit-unit kompetensi yang berkaitan dengan dasar-dasar teknologi informasi:

4.1.1 TIK.PR02.004.01 Menggunakan spesifikasi program.

4.1.2 TIK.PR02.006.01  Menulis program lanjut.

4.1.3  TIK.PR02.012.01  Mengkompilasi dan menjalankan sebuah aplikasi.

4.1.4  TIK.PR02.013.01  Menulis dan mengkompilasi kode sesuai kebutuhan.

4.2. Unit ini juga mendukung kinerja dalam unit-unit kompetensi yang berkaitan dengan:

4.2.1 Bidang pengembangan program.

4.2.2 Konfigurasi pengelolaan program.

4.2.3 Quality assurance.

4.2.4 Mengoperasikan aplikasi pengolah data.

4.3   Pengembangan pelatihan untuk memenuhi persyaratan dalam unit ini perlu dilakukan dengan hati-hati. Untuk pelatihan pra kejuruan umum, institusi harus menyediakan pelatihan yang mempertimbangkan serangkaian konteks industri seutuhnya tanpa bias terhadap sektor tertentu. Batasan variabel akan membantu dalam hal ini. Untuk sektor tertentu/khusus, pelatihan harus disesuaikan untuk memenuhi kebutuhan sektor tersebut.

 

2.3.7 Kompetensi Kunci

          Kompetensi kunci dalam bahasan ini dapat dilihat dalam tabel di bawah ini.

No.

KOMPETENSI KUNCI DALAM UNIT INI

TINGKAT

1.

Mengumpulkan, mengorganisir dan menganalisa informasi

2

2.

Mengkomunikasikan ide-ide dan informasi

2

3.

Merencanakan dan mengorganisir aktivitas-aktivitas

1

4.

Bekerja dengan orang lain dan kelompok

1

5.

Menggunakan ide-ide dan teknik matematika

1

6.

Memecahkan masalah

1

7.

Menggunakan teknologi

1

Tabel 2 Kompetensi Kunci

 


BAB III

STRATEGI DAN METODE PELATIHAN

 

3.1        Strategi Pelatihan

Belajar dalam suatu Sistem Berbasis Kompetensi berbeda dengan yang sedang “diajarkan” di kelas oleh Pelatih. Pada sistem ini Anda akan bertanggung jawab terhadap belajar Anda sendiri, artinya bahwa Anda perlu merencanakan belajar Anda dengan Pelatih dan kemudian melakukan praktek sesuai dengan rencana yang telah dibuat.

 

Persiapan/perencanaan

  1. Membaca bahan/materi yang telah diidentifikasi dalam setiap tahap belajar dengan tujuan mendapatkan tinjauan umum mengenai isi proses belajar Anda.
  2. Membuat catatan terhadap apa yang telah dibaca.
  3. Memikirkan bagaimana pengetahuan baru yang diperoleh berhubungan dengan pengetahuan dan pengalaman yang telah Anda miliki.
  4. Merencanakan aplikasi praktik pengetahuan dan keterampilan Anda.

 

Permulaan dari proses pembelajaran

  1. Mencoba mengerjakan seluruh pertanyaan dan tugas praktik yang terdapat pada tahap belajar.
  2. Merevisi dan meninjau materi belajar agar dapat menggabungkan pengetahuan Anda.

 

Pengamatan terhadap tugas praktik

  1. Mengamati keterampilan praktik yang didemonstrasikan oleh Pelatih atau orang yang telah berpengalaman lainnya.
  2. Mengajukan pertanyaan kepada Pelatih tentang konsep sulit yang Anda temukan.

 

Implementasi

  1. Menerapkan pelatihan kerja yang aman.
  2. Mengamati indikator kemajuan personal melalui kegiatan praktik.
  3. Mempraktikkan keterampilan baru yang telah Anda peroleh.

 

Penilaian

Melaksanakan tugas penilaian untuk penyelesaian belajar Anda.

 

3.2        Metode Pelatihan

Terdapat tiga prinsip metode belajar yang dapat digunakan. Dalam beberapa kasus, kombinasi metode belajar mungkin dapat digunakan.

 

Belajar secara mandiri

Belajar secara mandiri membolehkan Anda untuk belajar secara individual, sesuai dengan kecepatan belajarnya masing-masing. Meskipun proses belajar dilaksanakan secara bebas, Anda disarankan untuk menemui Pelatih setiap saat untuk mengkonfirmasikan kemajuan dan mengatasi kesulitan belajar.

 

Belajar Berkelompok

Belajar berkelompok memungkinkan peserta untuk dating bersama secara teratur dan berpartisipasi dalam sesi belajar berkelompok. Walaupun proses belajar memiliki prinsip sesuai dengan kecepatan belajar masing-masing, sesi kelompok memberikan interaksi antar peserta, Pelatih dan pakar/ahli dari tempat kerja.

 

Belajar terstruktur

Belajar terstruktur meliputi sesi pertemuan kelas secara formal yang dilaksanakan oleh Pelatih atau ahli lainnya. Sesi belajar ini umumnya mencakup topik tertentu.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


BAB IV

MATERI UNIT KOMPETENSI

4.1 Tujuan Instruksional Umum

  • Dapat membuat dokumen teknis berdasarkan template dan petunjuk penulisan yang telah disediakan.
  • Dapat membuat struktur dokumen berdasarkan aliran informasi dan standar dokumen yang digunakan.
  • Dapat membuat dokumen teknis dengan menggunakan kaidah bahasa yang benar.
  • Dapat merevisi dan mengkoreksi dokumen teknis berdasarkan aliran informasi, standar dokumen, dan tata bahasa.
  • Dapat mempublikasikan dokumen teknis menggunakan media.
  • Siswa dapat menjelaskan dokumen teknis yang sesuai kebutuhan.
  • Siswa dapat mengetahui layout yang sesuai dengan kebutuhan informasi yang dibutuhkan oleh dokumen teknis.
  • Siswa dapat mengetahui format dokumen dan petunjuk penulisan dokumen.
  • Siswa dapat mengetahui lingkupan pekerjaan yang dibutuhkan dalam penyusunan dokumen.
  • Siswa dapat mengidentifikasi data yang relevan untuk isi dokumen teknis.
  • Siswa dapat mengetahui lingkup dan standar dokumen dari isi dokumen teknis.
  • Siswa dapat mengetahui standar yang dipakai dalam pembuatan dokumen.
  • Siswa dapat mengetahui cara penulisan dokumen sesuai kaidah bahasa yang benar.
  • Siswa dapat mengetahui hubungan antara standar dokumen dan aliran informasi dalam merevisi dokumen.
  • Siswa dapat mengetahui tujuan dokumen teknis dikoreksi.
  • Mengetahui tujuan mempublikasikan dokumen.

4.2 Tujuan Instruksional Khusus

 

4.3    Uraian Singkat Materi

Membuat Dokumen Teknis

 

Buku informasi ini menjelaskan tentang bagaimana mengidentifikasi data untuk kebutuhan dokumen teknis, yang menyangkut mengidentifikasi dokumen teknis sesuai dengan kebutuhan, mengacu kebutuhan informasi sesuai dengan layout dan standar dokumen, menyiapkan template dan petunjuk penulisan, dan menggunakan lingkupan pekerjaan sesuai dengan batasan waktu, teknologi yang digunakan dan sumber daya yang dipakai. Buku informasi ini juga menjelaskan tentang mengidentifikasi data yang relevan dengan isi dokumen teknis, menggunakan isi dokumen teknis sesuai dengan lingkup dan standar dokumen, menggunakan struktur dokumen dibuat atas dasar aliran informasi dan standar dokumen. Selain itu juga, dijelaskan tentang membuat Isi dokumen teknis sesuai dengan struktur dokumen, membuat format dokumen sesuai dengan standar yang dipakai, membuat penulis dokumen sesuai kaidah bahasa yang benar. Dan yang terakhir akan dibahas tentang bagaimana merevisi dokumen atas dasar standar dokumen dan aliran informasi, mengkoreksi dokumen sebagai jaminan bagi kesempurnaan teknis dan tata bahasa, melengkapi dokumen agar terpenuhinya kebutuhan dokumen teknis, dan mempublikasikan dokumen agar terpenuhinya kebutuhan pengguna.

 

4.4    Beberapa Pengertian dalam Unit Kompetensi Ini :

1. Ambiguitas       : Mempunyai arti lebih dari satu atau mempunyai peluang untuk memberikan beberapa peafsiran oleh orang-orang yang membaca.

2. Font                  : Huruf.

 

4.5    Informasi masing-masing elemen kompetensi:

4.5.1   Mengidentifikasi data untuk kebutuhan dokumen teknis

 

1) Pengetahuan Kerja

 

Dalam bagian ini akan dibahas tentang bagaimana mengidentifikasi data untuk kebutuhan dokumen teknis, mengacu kebutuhan informasi sesuai dengan layout dan standar dokumen, menyiapkan template dan petunjuk penulisan, dan menggunakan lingkupan pekerjaan sesuai dengan batasan waktu, teknologi yang digunakan dan sumber daya yang dipakai.

Dokumen teknis diidentifikasi sesuai kebutuhan.

Dalam pembuatan dokumen teknis suatu program atau aplikasi yang sudah selesai dibangun, si penulis harus benar-benar mengerti teknikal dari aplikasi tersebut, sehingga dapat menuangkannya dalam tulisan dengan jelas dan tidak ambiguitas agar mudah dimengerti oleh orang lain.

Pembuatan suatu dokumen teknis harus disesuaikan dengan kebutuhan. Kebutuhan pembuatan dokumen teknis tentu saja untuk memberikan informasi kepada klien tentang bagaimana cara-cara menginstal aplikasi dan hal-hal apa saja yang harus dipersiapkan untuk mendukung instalasi tersebut. Penyajian data  harus lebih terfokus pada “kepada siapa” dokumen teknis tersebut ditujukan. Dokumen teknis harus disajikan sesederhana mungkin, sehingga mudah dimengerti pembaca dan dapat membantu orang lain untuk menginstal aplikasi tersebut. Jadi pengidentifikasian dokumen teknis harus benar-benar diperhatikan.

Kebutuhan informasi sesuai dengan layout dan standar dokumen yang diacu.

Setiap dokumen mempunyai standar yang harus diacu supaya dokumen tersebut layak dikatakan sebagai dokumen yang baik dan benar. Tujuan dibuatnya suatu dokumen teknis instalasi adalah untuk menginformasikan kepada setiap pembaca bagaimana cara-cara menginstal suatu aplikasi. Penyajian informasi ini tentunya diharapkan akan dapat membantu orang yang akan menggunakan aplikasi tersebut.

 

Klien atau pengguna adalah sasaran utama pembuatan dokumen teknis. Oleh karena itu untuk menghasilkan informasi yang dapat memuaskan klien, maka kita harus menyesuaikan kebutuhan informasi yang akan disajikan sesuai dengan layout dan standar dokumen yang diacu.

Template dan petunjuk penulisan disiapkan.

Pembuatan dokumen teknis tanpa adanya template yang sudah disiapkan akan menghasilkan suatu dokumen teknis yang tidak terarah, bertele-tele, menimbulkan pengertian yang ambiguitas dan dokumen teknis yang tidak sistematis. Karena itu sebelum kita membuat suatu dokumen teknis, kita harus mempersiapkan terlebih dahulu template dokumen yang harus kita acu. Template dokumen ini menyangkut tentang struktur pembagian isi dari dokumentasi. Dokumen teknis instalasi mempunyai beberapa template. Dokumen teknis instalasi suatu program aplikasi untuk bisnis proses suatu perusahaan akan berbeda dengan dokumen teknis instalasi suatu aplikasi jaringan. Tetapi dalam pembahasan ini Penulis akan membahas secara umum. Template merupakan patokan atau panduan yang sudah terstruktur, sehingga kita hanya mengisi atau menjelaskan informasi sesuai dengan urutan struktur yang ada di dalam template. Tetapi bukan berarti kita tidak boleh menambah atau mengurangi bagian-bagian dari template tersebut, bisa saja selagi apa yang kita kurangi atau kita tambahi itu tidak mengganggu isi dokumen secara keseluruhan.

 

Sebelum pembuatan dokumen teknis, penulis juga harus mempersiapkan petunjuk penulisan yang benar, sehingga dokumen yang disajikan sesuai dengan penulisan dokumen yang benar. Penulisan dokumen teknis instalasi adalah hal yang sudah biasa dalam dunia teknologi pemograman. Namun, dalam pembuatan dokumen teknis sering kita menemukan kesalahan-kesalahan penulisan karena tidak memperhatikan petunjuk penulisan yang benar. Petunjuk penulisan dokumen teknis ini ditujukan dalam penggunaannya dalam Bahasa Indonesia. Jadi dalam pembahasan ini Penulis akan berbicara tentang pembuatan dokumen teknis dalam Bahasa Indonesia.

 

Kekeliruan yang sering terjadi dalam pembuatan dokumen teknis adalah:

  1. Penggunaan jenis font yang tidak formal.

Kita sering menemui adanya pemilihan jenis font arial dalam penulisan dokumen bahkan dalam tulisan-tulisan yang digunakan lembaga pendidikan. Penggunaan jenis font  menggunakan font semacam Arial dalam menulis dokumen formalmerupakan penggunaan yang kurang tepat.

  1. Pengaturan layout dokumen yang tidak standar.

Sekadar informasi, ukuran margin standar sebuah dokumen formal adalah margin atas 4cm, bawah 3.5 cm, kiri 4 cm, dan kanan 2.5 cm.

  1. Penulisan kalimat yang tidak memperhatikan kaidah pembuatan sebuah kalimat yang benar.

Kalimat tidak memiliki subjek, predikat, objek yang jelas. Penulisan yang salah dapat dilihat dalam contoh berikut ini :

Hal ini bisa saja dilakukan oleh orang dalam maupun orang luar dengan motivasi beragam. Mulai dari mencuri informasi berharga, mencuri uang, vandalisme ataupun sekadar iseng belaka.

Lihat kalimat di atas. Kalimat kedua tidak memiliki struktur subjek predikat yang jelas. Kalimat kedua mungkin dimaksudkan untuk menjelaskan apa yang sudah ada dalam kalimat pertama. Mungkin akan lebih baik jika kalimat kedua diawali dengan :

“….. dengan motivasi beragam. Banyak hal yang dapat menjadi motivasi orang untuk mencuri, mulai dari mencuri informasi……”

  1. Penulisan kalimat yang panjang-panjang. Ini adalah kekeliruan yang paling sering dijumpai. Penulis terjebak dalam suatu penyajian data dan pokok pikiran dalam kalimat yang panjang.  Penyajian ini tidak disadari penulis akan mempersulit si pemabca untuk mengambil ide atau pokok pikiran informasi. Lihat contoh kalimat berikut ini :

Media massa mempengaruhi konteks sosial, dan konteks sosial mempengaruhi media massa, terjadi hubungan transaksional antara media dan masyarakat.

Sudah membaca kalimat di atas? Apa tanggapan Anda? Saya sendiri walalupun mengerti apa yang ingin disampaikan penulis, merasa kurang nyaman dalam membaca kalimat tersebut. Hal ini juga berkaitan erat dengan poin nomor 3, struktur kalimatnya tidak jelas. Hal ini rupanya juga terjadi dalam penulisan aturan pemerintah (undang-undang dan teman-temannya). Panjang lebar, memutar-mutar, dan tidak jelas.

  1. Membuka bab/subbab langsung dengan daftar.

Adalah suatu hal yang tidak enak dilihat jika sebuah bab/subbab dimulai tanpa adalah kalimat pengantarnya. Saran saya jika sebuah subbab sebenarnya hanya berisi daftar, mulailah subbab dengan kalimat pengantar. Lihat contoh ini :

1.2 Tujuan

  • Mendapatkan suatu metode ….
  • Mendapatkan suatu cara sistematis …
  1. Membagi struktur badan dokumen dengan penomoran yang tidak standar.

Adanya penulisan subbab dalam dokumen dengan penomoran yang menggunakan huruf. Hal ini sangat tidak lazim dan sangat tidak dianjurkan. Sebagai contoh, Bab 1 memiliki subbab A, B, dan seterusnya.

  1. Penulisan kata bahasa asing secara tidak tepat.  Sebagai contoh,

Operating System yang digunakan adalah Windows.

  1. Penggunaan kata-kata yang tidak baku dan tidak sesuai dengan kaidah bahasa yang benar.

Untuk mengatasi dan menghindari kekeliruan di atas penulis harus mengetahui cara-cara penulisan dan penyajian data dalam dokumen secara keseluruhan. Cara-cara penulisan dokumen yang benar akan dibahas dalam bagian berikutnya.

Lingkupan pekerjaan sesuai dengan batasan waktu, teknologi dan Sumber Daya Lainnya

 

Dokumen teknis instalasi harus memuat lingkupan pekerjaan dengan jelas, sesuai dengan batasan waktu yang ditentukan, teknologi yang dan sumber daya lain yang dibutuhkan. Maksud dai point-point ini adalah sebagai berikut:

  1. Lingkupan pekerjaan sesuai dengan batasan waktu

Menyangkut pekerjaan apa saja yang dilakukan dalam satu satuan waktu yang telah ditentukan. Bagian ini adalah hal yang penting karena menyangkut batasan waktu. Identifikasi atau penentuan pekerjaan harus benar-benar disusun sesuai dengan jangka waktu yang telah ditentukan.

  1. Teknologi

Yang dimaksud dengan teknologi dalam bagian ini adalah kita harus menerangkan teknologi apa yang digunakan dalam membangun aplikasi. Teknologi menyangkut bahasa pemograman yang digunakan, peralatan-peralatan terkait. Contoh spesifikasi-spesifikasi tersebut adalah:

 

Kasus:

Program yang dibangun adalah suatu aplikasi HR dan Payroll yang dibangun dengan bahasa pemograman VB 6.0.

  • Sistem Operasi                 : Windows 98, Windows XP
  • SIstem Operasi Server       : Windows Server 2000
  • Bahasa Pemograman         : VB 6.0
  • Pemograman Database      : SQL Server 2000
  • Pemograman Reporting     : Crystal Report 8.5
    • Peralatan                   : Monitor, Keyboard, CPU, dan Mouse

 

  1. Sumber Daya

Menyangkut resource yang diperlukan untuk mendukung jalannya aplikasi tersebut. Contoh berdasarkan kasus di atas:

  • Database Administrator (DBA)     : 2 orang
    • Pengguna Aplikasi                      : Tergantung dengan hak akses aplikasi yang diberikan oleh klien, contoh user yang berhak mengakses payroll dan mengakses HR berbeda. Jadi dibutuhkan dua orang untuk mengelola aplikasi. Tapi minimal pengguna aplikasi adalah satu orang.

 

2) Ketrampilan Kerja

Mengidentifikasi data untuk kebutuhan dokumen teknis.

 

  • Mengumpulkan informasi yang berhubungan untuk mengidentifikasi data untuk kebutuhan dokumen teknis.
  • Mencari referensi untuk mengidentifikasi data untuk kebutuhan dokumen teknis.

 

Mengacu kebutuhan informasi sesuai dengan layout dan standar dokumen.

 

  • Mencari dan mengakses informasi tentang layout dan standar dokumen.
  • Mengacu kebutuhan informasi sesuai dengan layout dan standar dokumen.

 

Menyiapkan template dan petunjuk penulisan

 

  • Mengumpulkan informasi dan referensi tentang template dan petunjuk penulisan.
  • Menggunakan informasi yang diperoleh untuk menyiapkan template dan petunjuk penulisan

 

Menggunakan lingkupan pekerjaan sesuai dengan batasan waktu, teknologi yang digunakan dan sumber daya yang dipakai

 

  • Mengumpulkan informasi tentang lingkupan pekerjaan sesuai dengan batasan waktu, teknologi yang digunakan dan sumber daya yang dipakai.
  • Mencari referensi tentang lingkupan pekerjaan sesuai dengan batasan waktu, teknologi yang digunakan dan sumber daya yang dipakai.

 

 

3) Sikap Kerja

Sikap kerja ditunjukkan pada saat praktek di lingkungan kerja.

  1. Mengidentifikasi dokumen teknis yang sesuai dengan kebutuhan
  2. Mengumpulkan informasi tentang layout, standar dokumen template, dan petunjuk penulisan.
  3. Mengacu kebutuhan informasi sesuai dengan layout dan standar dokumen.
  4. Menyiapkan template dan petunjuk penulisan.

 

4.5.2 Merencanakan pembuatan dokumen teknis

 

1) Pengetahuan Kerja

 

Dalam bagian ini akan dibahas tentang pengidentifikasian data yang relevan yang akan dimuat di dokume teknis, penyesuaian isi dokumen dengan lingkup dan standar dokumen yang telah ditentukan, dan membuat struktur dokumen dengan dasar aliran informasi dan standar dokumen yang sudah ditentukan.

Data yang relevan dengan isi dokumen teknis diidentifikasi.

Data yang relevan adalah data yang tepat disajikan sesuai dengan tujuan tulisan tersebut. Data yang relevan berarti data yang tidak melenceng dari tujuan dibuatnya tulisan tersebut, data yang disajikan sesuai dengan judul dari modul tersebut. Untuk lebih spesifiknya data harus sesuai dengan judul bab maupun judul sub bab, karena judul dari bab atau sub bab menggambarkan data yang harus disajikan dalam dokumen teknis instalasi. Jika kita berbicara dengan rumah maka yang dibicarakan tentang perumahan, berupa desain rumah, perabotan dan lain-lain, bukan tentang perkebunan. Pada bagian ini kita akan menjelaskan bagaimana mengidentifkasi data yang relevan dengan isi dokumen teknis instalasi suatu aplikasi.  Data apa-apa saja yang tepat untuk mendukung buku teknis instalasi suatu aplikasi. Berikut cara-cara untuk mengidentifikasi data supaya relevan dengan isi dokumen teknis, yaitu:

  1. Mengetahui terlebih dahulu tujuan dari pembuatan dokumen teknis
  2. Mengetahui sejauh mana ruang lingkup dan batasan-batasan dari pembahasan dokumen teknis intalasi
  3. Memahami apa yang tersirat dalam setiap judul bab dan sub bab dalam dokumen

Penyajian data dalam dokumen teknis dapat melibatkan referensi-referensi dari buku, artikel atau sumber informasi lain, tetapi data tersebut harus tetap sesuai dengan ruang lingkup pembahasan dokumen.

 

Berikut merupakan contoh dari data yang perlu untuk disajikan dalam dokumen teknis instalasi:

  1. Menyajikan data yang perlu dipersiapkan untuk mendukung berjalannya instalasi, yaitu berupa media atau peralatan-peralatan yang dibutuhkan, seperti hal-hal di bawah ini:

 

  • Sistem Operasi, yang mendukung aplikasi
  • Sistem Operasi Server, yang mendukung aplikasi
  • Bahasa Pemograman, jika aplikasi pemograman membutuhkan suatu software bahasa pemograman untuk mendukung aplikasi
  • Pemograman Database, jika aplikasi pemograman membutuhkan suatu software bahasa pemograman database untuk mendukung berjalannya aplikasi.
  • Pemograman Reporting, jika aplikasi pemograman membutuhkan suatu software bahasa pemograman untuk mendukung berjalannya aplikasi.
  • Fasilitas internet atau intranet yang perlu dipersiapkan untuk mendukung berjalannya aplikasi tersebut (fasilitas ini hanya sebagai persyaratan jika dibutuhkan saja).

 

  1. Menyajikan data bagaimana cara-cara penginstalan aplikasi. Sebaiknya cara-cara penginstalan ini disajikan sesederhana mungkin, sehingga mudah dimengerti da diikuti oleh orang lain atau bahkan klien yang akan menggunakan aplikasi klien. Contoh penyajian cara-cara penginstalan aplikasi ini dapat dilihat dengan contoh di bawah ini.

 

Kasus: Instalasi Joomla secara manual

 

Database Setup

  • Login ke cPanel dan klik pada link MySQL Databases.
  • Cari tombol “Create Database”. Di sini tempat membuat database MySQL web Joomla yang akan diinstal untuk menyimpan arikel, berita, comment, pools, dan lain-lain.
  • Pilih nama yang sederhana dan mudah diingat seperti Joomla. Masukkan nama database dan tekan tombol “Create Database.
  • Setelah berhasil membuat database, anda perlu memastikan bahwa web Joomla dapat mengaksesnya. Untuk itu dibutuhkan user MySQL yang memiliki hak akses ke database tersebut.
  • Silahkan navigasikan cPanel ke cPanel > MySQL Databases dan cari tombol “Create User”.
  • Masukan username dan password untuk user MySQL. Supaya untuk Create diingat, masukkan username sesuai dengan nama database Joomla. Catat username dan password anda.
  • Tekan tombol “Create User”. Setelah membuat user, sekarang tinggal memberi user hak akses untuk database Joomla.
  • Di cPanel > MySQL Databases, cari dua drop-down untuk user dan database.
  • Pilih Joomla database dan user yang baru dibuat dan set Privileges ke ALL dan tekan “Add User to Database”

 

Upload File

Database sudah online dan tinggal diisi data. Yang harus dilakukan sekarang adalah upload file-file Jommla ke account anda.

  • Kunjungi web Joomla di www.joomla.org dan download file yang terbaru.
  • Extrak file tersebut ke komputer. Lalu jalankan aplikasi FTP dan upload ke direktori yang diinginkan. Kalau ingin menjadikan Joomla sebagai web utama silahkan upload file-file Joomla ke dalam direktori public_html supaya Joomla dapat diakses melalui http://yourdomain.com/

    public_html/index.php
    public_html/installation/
    public_html/components/
    etc.

    Jika anda ingin instal Joomla di sub-directory, buat sebuah direktori di dalam public_html dan upload semua file ke direktori tersebut. Untuk contoh, jika Joomla ingin diinstal ke http://www.yourdomain.com/joomlasite/, silahkan buat direktori public_hmtl/joomlasite dan upload file-file Joomla ke situ yang nantinya akan akan kelihatan seperti:

    public_html/joomlasite/index.php
    public_html/joomlasite/components/

 

Instalasi
Setelah semua file berhasil diupload, sekarang tinggal diinstal.

 

  • Buka browser dan kunjungi alamat dimana Joomla anda diupload. Kita akan mengambil asumsi bahwa Joomla akan digunakan sebagai web utama, jadi ketik www.yourdomain.com di browser. Langkah-langkah instalasi sangat mudah dan dijelaskan dengan detail, jadi kita akan membahas hal yang penting di detail instalasi.

Pre-installation Check

Anda akan mendapat peringatan mengenai Register Globals yang diset on. Jangan khwatir, ini tidak akan jadi masalah nantinya. Klik “Next” untuk melanjutkan.
License
Lisensi Joomla berdasarkan GPL. Silahkan baca aturan lisensi dan klik “Next” untuk melanjutkan.
Langkah 1

MySQL database configuration: Anda harus memberitahu Joomla bagaimana mengakses databasenya. Tidak lama sebelum ini, saya harap tidak lama, anda diminta untuk membuat database MySQL dan user. Silahkan masukkan detail yang ke dalam textbox yang telah disediakan.

Catatan:
Nama database dan username akan diberi prefiks “username_” dimana username ini diambil dari login cPanel.
Jangan lupa password user MySQL case-sensitive.

Untuk textbox “Host Name” masukkan nilai “localhost”. Nilai yang lain tidak perlu diganti. Tekan “Next” dan popup akan muncul untuk mengkonfirmasikan informasi yang telah anda masukkan. Jangan kuatir kalau ada sekasalah pada saat instalasi, anda akan dibawa kembali ke halaman yang belum benar. Klik “OK”.

 

Langkah 2
Site Name: masukkan nama untuk website anda, sebagai contoh “My Personal Joomla Webiste”.

 

Langkah 3

Bagian ini alah bagian terpenting dari instalasi Joomla, dimana anda diminta untuk mengkonfirmasikan alamat URL dan sistem path untuk file-file. Jangan ganti nilai-nilai tersebut kecuali anda tahu apa yang anda inginkan dan apa yang lakukan.

Masukkan alamat email anda di “Your e-mail”. Ini tidak menyebabkan inbox anda penuh terisi oleh SPAM dan alamat email ini tidak akan muncul di halaman website. Email disini berguna untuk mengirimkan password kalau anda lupa password dan pemberitahuan akan kejadian-kejadian yang terjadi di web anda.

Masukkan password administrator di “Admin Password”. Dan jangan ganti setting-an yang lain.
Langkah 4

Ganti nama file configuration.php-dist menjadi configuration.php dan copy code yang ada dalam box tadi, paste di configuration.php lalu upload
Langkah 5

Joomla anda sebentar lagi online. Catat username administrator dan password, ini sangat penting. Sebelum dapat mengakses web Joomla, anda harus menghapus direktori “installation” yang ada di direktori Joomla. Hapus direktori tersebut dari FTP atau cPanel > File Manager. Setalah direktori ini dihapus, Joomla anda akan online.

 

  1. Sajikan cara-cara re-check apakah hasil instalasi yang sudah dilakukan berhasil atau tidak. Hal ini dapat dilakukan dengan menyajikan standar-standar pengujian yang harus dipenuhi oleh aplikasi yang sudah diinstal.

 

Penyajian langkah-langkah dalam menginstal suatu aplikasi sebaiknya disajikan dengan menggunakan bullet atau numbering sehingga lebih sistematis, dan mudah diikuti. Selain itu juga dapat dilengkapi dengan pemberian huruf yang di-bold, sebagai pertanda bahwa point-point tersebut penting dan sangat perlu diperhatikan.

 

Isi dokumen teknis sesuai dengan lingkup dan standar dokumen yang digunakan.

 

Seperti yang telah dikatakan sebelumnya bahwa dalam pembuatan dokumen teknis itu harus mengikuti template dan standar dokumen yang benar sesuai dengan ketetapan penulisan dokumen yang benar. Pembuatan dan pemilihan standar dokumen sudah benar-benar dipertimbangkan sehingga akan membantu dan memudahkan si penulis untuk menyajikan data yang perlu dan relevan. Standar ini juga pastinya dengan sudah benar-benar memperhitungkan kesesuaian aliran data yang di dalamnya. Standar dokumen yang biasanya dipakai bermacam-macam tetapi walaupun demikian masing-masing standar itu tidak terlalu jauh berbeda.

Isi dokumen teknis yang disajikan harus disesuaikan dengan ruang lingkup dan standar dokumen yang telah ditentukan. Sehingga isi dokumen teknis yang disajikan tidak meluas dan bertele-tele, tetapi sistematis sesuai dengan tujuan pembuatan dokumen.

Struktur dokumen dibuat berdasarkan aliran informasi dan standar dokumen yang di gunakan

Struktur dokumen yang dibuat sebagai acuan penyajian data harus disesuaikan dengan aliran informasi dan standar dokumen yang digunakan. Pembuatan struktur dokumen harus disesuaikan dengan hasil identifikasi data yang relevan untuk disajikan dalam dokumen. Tetapi dalam pembuatan struktur dokumen ada beberapa bagian yang harus disajikan dalam dokumen, yang merupakan bagian dasar dari suatu dokumen, bukan hanya untuk dokumen teknis instalasi tetapi untuk dokumen formal lainnya. Pembuatan struktur dokumen juga harus memperhatikan aliran data supaya saling berhubungan satu sama lain. Hal ini terlihat dengan jelas pada bagian pembahasan, yaitu bagaimana persiapan-persiapan instalasi disiapkan terlebih dahulu sebelum melakukan prosedur instalasi. Contoh struktur dokumen teknis instalasi adalah sebagai berikut:

 

Salah satu contoh struktur standar dokumen tersebut dapat dilihat di bawah ini:

 

DAFTAR ISI à Berisi keseluruhan daftar atau struktur isi dari data yang disajikan dalam dokumen teknis instalasi.

 

  1. Pendahuluan, bagian ini mempunyai sub bagian sebagai berikut:
    1. Latar Belakang Penulisan Dokumen

Berisi hal-hal apa saja yang melatarbelakangi dibuatnya dokumen teknis tersebut.

  1. Tujuan Penulisan Dokumen

Berisi tujuan-tujuan yang mendasari penulisan dokumen

  1. Ruang Lingkup

Berisi ruang lingkup pembahasan yang disajikan dalam dokumen, atau bisa juga dikatakan bagian ini merupakan batasan-batasan pembahasan dari dokumen teknis.

  1. Definisi, akronim dan dan singkatan

Berisi kata-kata yang berupa istilah-istilah yang dipergunakan dalam dokumen teknis. Dalam bagian ini dijelaskan arti dari istilah-istilah tersebut. Begitu juga dengan kata-kata akronim dan juga singkatan-singkatan.

  1. Aturan Penomoran

Bagian ini berisi tentang aturan-aturan penomoran yang digunakan dalam dokumen teknis instalasi.

  1. Dokumen Rujukan

Bagian ini sering tidak disertakan dalam dokumen, karena biasanya bisa digantikan dengan daftar pustaka atau referensi.

  1. Ikhtisar Dokumen

Bagian ini berisi dengan ringkasan dari semua isi dari dokumen, khususnya yang berkaitan dengan pembahasan.

  1. Deskripsi Umum Sistem

Bagian ini berisi dengan gambaran aplikasi secara keseluruhan. Aplikasi dijelaskan untuk memberikan gambaran secara umum kepada pembaca khususnya si klien. Untuk gambaran aplikasi secara keseluruhan dan detail, dijelaskan pada dokumen aplikasi yag khusus, yang diberikan kepada klien pengguna aplikasi tersebut.

  1. Pembahasan

Bagian ini merupakan bagian yang sangat penting dalam dokumentasi teknis instalasi. Pembahasan mempunyai dua bagian yang utama yang sangat penting, yaitu:

  1. Persiapan Instalasi

Pada bagian ini disajikan persiapan-persiapan atau apa-apa saja yang perlu dipersiapkan sebelum melakukan penginstalan. langkah-langkah penginstalan aplikasi secara lengkap dan detail. Bagian-bagian yang perlu dipersiapkan sebelum melakukan instalasi, adalah:

  1. Persiapan Instalasi Perangkat Keras
  2. Persiapan Instalasi Perangkat Lunak
  3. Persiapan Materi
  4. Persiapan Prosedur
  5. Parameter Setting
  6. Prosedur Instalasi

Pada bagian ini disajikan langkah-langkah atau prosedur penginstalan aplikasi secara lengkap dan detail. Prosedur-prosedur instalasi yang perlu dibahas tergantung dengan kebutuhan aplikasi. Bagian-bagian yang disajikan di bawah ini salah satu contoh untuk bagian-bagian prosedur instalasi:

  1. Prosedur Instalasi Sistem Operasi, bagian dapat berisi tentang karakteristik sumber daya manusia, instruksi kerja, keadaan awal dan keadaan akhir setelah prosedur dijalankan, error yang terjadi dan penanggulangannya.
  2. Prosedur Instalasi Aplikasi, bagian dapat berisi tentang karakteristik sumber daya manusia, instruksi kerja, keadaan awal dan keadaan akhir setelah prosedur dijalankan, error yang terjadi dan penanggulangannya.
  3. Pelaporan

Setelah instalasi dilakukan, dokumen panduan instalasi akan diserahkan kepada pihak perusahaan, serta akan dilaksanakan demo Penjelasan singkat mengenai hasil instalasi dan konfigurasi. Pelaporan ini juga dibuat untuk memberitahukan bagaimana pencapaian hasil dari proses instalasi dan kesulitan yang dihadapi.

  1. Daftar Pustaka

Berisi sumber – sumber informasi yang mendukung penmbuatan dari dokumen teknis instalasi.

  1. Sejarah Versi

Bagian ini berisi daftar sejarah versi, untuk penulisan yang lebih baik dapat ditampilkan dalam bentuk tabel. Contoh dari sejarah versi ini seperti di bawah ini:

 

No. versi

Tanggal

Ditulis Oleh

Direview Oleh

Disetujui oleh

Draft

 22 Juni 2005 Tim Pembimbing PT Kiani Kertas Pembimbing PT Kiani Kertas

01

 04 Juli 2005 Tim Inggriani Liem Inggriani Liem

02

 05 Juli 2005 Tim Albert Sagala Albert Sagala

Tabel 1 Sejarah Versi daftar isi

 

  1. Sejarah Perubahan

Bagian ini berisi daftar sejarah perubahan, untuk penulisan yang lebih baik dapat ditampilkan dalam bentuk tabel. Contoh dari sejarah perubahan ini seperti di bawah ini:

 

No. dokumen : Ins-KP-05-206A.doc

No. versi       : 01


 

Halaman

Semula

Menjadi

Alasan perubahan

 6 – 7 Aturan penomoran dilakukan berdasarkan bab dan subbab yang ada Aturan penomoran mengacu kepada dokumen standar Tidak sesuai dengan dokumen standar
 14, 16, 24, 25 Membongkar Ekstraksi Menyesuaikan dengan maksud dari kalimat
 11, 15, 17, 22, 23,   24, 25, 31 Di jalankan Dijalankan Tidak sesuai dengan aturan penulisan

Tabel 2 Sejarah Perubahan

 

DAFTAR TABEL

Berisi daftar tabel yang disajikan dalam dokumen teknis. Bagian ini dibuat hanya jika ada penggunaan tabel dalam dokumen teknis instalasi.

 

DAFTAR GAMBAR

Berisi daftar gambar yang disajikan dalam dokumen teknis. Bagian ini dibuat hanya jika ada penggunaan gambar dalam dokumen teknis instalasi.

 

Pada bagian-bagian tertentu struktur dokumen di atas dijelaskan bahwa struktur dokumen tersebut tidak suatu keharusan disajikan seratus persen dalam dokumen teknis instalasi.

 

Contoh dokumen yang menggunakan struktur di atas dapat dilihat dari daftar isi, daftar tabel, dan daftar gambar di bawah ini.

 


Daftar Isi

1    Pendahuluan………………………………………………………………………. 1

1.1     Tujuan Penulisan Dokumen………………………………………………….. 1

1.2     Ruang Lingkup…………………………………………………………………. 1

1.3     Definisi…………………………………………………………………………… 1

1.4     Dokumen Rujukan……………………………………………………………… 2

1.5     Ikhtisar Dokumen……………………………………………………………… 2

2    Gambaran Aplikasi………………………………………………………………. 4

2.1     Ruang Lingkup…………………………………………………………………. 4

2.2     Paket Kerja……………………………………………………………………… 4

3    Pembahasan……………………………………………………………………….. 5

3.1     Peralatan-Peralatan yang Dipersiapkan……………………………………. 6

3.2     Aplikasi pendukung Disediakan……………………………………………… 6

3.3     Instalasi…………………………………………………………………………. 6

3.3.1     Database                                                                        7

3.3.2     Internet                                                                         7

4    Penutup……………………………………………………………………………… 8

Daftar Pustaka…………………………………………………………………………. 8

 

 

 

Daftar Tabel

 

 

Gambar 1 Tampilan pembuatan Web services 6

 

 

Daftar Gambar

 

Gambar 1 Tampilan pembuatan Web services 6

 

 


2) Ketrampilan Kerja

Mengidentifikasi data yang relevan dengan isi dokumen teknis.

 

  • Mengumpulkan informasi data yang relevan dengan isi dokumen teknis.
  • Mencari referensi dan kasus-kasus tentang data yang relevan dengan isi dokumen teknis.

 

Menggunakan isi dokumen teknis sesuai dengan lingkup dan standar dokumen.

 

  • Mencari informasi tentang bagaimana menggunakan isi dokumen teknis sesuai dengan lingkup dan standar dokumen.
  • Menggunakan isi dokumen teknis sesuai dengan lingkup dan standar dokumen.

 

Menggunakan struktur dokumen dibuat atas dasar aliran informasi dan standar dokumen

 

  • Mengumpulkan informasi dan referensi tentang struktur dokumen.
  • Menggunakan struktur dokumen dibuat atas dasar aliran informasi dan standar dokumen.

 

3) Sikap Kerja

Sikap kerja ditunjukkan pada saat praktek di lingkungan kerja.

1. Mengumpulkan informasi tentang data yang relevan dengan isi dokumen teknis dan struktur dokumen.

2. Menggunakan isi dokumen teknis sesuai dengan lingkup dan standar   dokumen dengan benar.

3. Menggunakan struktur dokumen dibuat atas dasar aliran informasi dan standar dokumen dengan benar.

 

4.5.3 Membuat/menulis dokumen teknis

 

1) Pengetahuan Kerja

 

Pada bagian ini akan dibahas tentang bagaimana membuat isi dokumen teknis disesuaikan dengan struktur dokumen, membuat format dokumen sesuai dengan standar yang dipakai, dan membuat penulisan dokumen sesuai dengan standar yang dipakai.

Isi dokumen teknis dibuat sesuai dengan struktur dokumen.

 

Setelah menyusun struktur dokumen teknis sesuai dengan aliran informasi yang benar, maka dokumen teknis harus diisi sesuai dengan struktur dokumen tersebut.

Format dokumen dibuat sesuai dengan standar yang dipakai.

Dalam pembuatan dokumen formal, format yang digunakan harus sesuai dengan standar yang sudah ditentukan dalam pembuatan dokumen. Format dokumen mencakup:

  1. Penggunaan jenis font yang standar. Dalam sebuah dokumen formal, jenis font yang pantas dan layak digunakan adalah jenis font berkait (misalnya Times Roman, Computer Modern, Tahoma), jenis ini untuk bagian isi dokumen yang normal. Untuk isi dokumen yang berupa sintaks atau code, dapat menggunakan jenis font yang lain juga (misalnya Arial).
  2. Ukuran font yang digunakan 12, dan menggunakan warna standar yaitu warna hitam.
  3. Penentuan margin dokumen dengan ukuran margin yang standar sebagaimana umumnya dokumen formal lainnya, yaitu margin atas 4cm, bawah 3.5 cm, kiri 4 cm, dan kanan 2.5 cm.
  4. Spasi yang digunakan ukurannya adalah 1.5.
  5. Kaidah penomoran yang digunakan dalam keseluruhan dokumen, sebagai contoh:
  • Penulisan bab, BAB I Pendahuluan, BAB II, dan seterusnya
  • Penulisan sub bab, 1.1 Tujuan Penulisan Dokumen, 1.2 Ruang Lingkup, dan seterusnya.
  • Penulisan bullet.
  1. Penggunaan gaya atau style penulisan, supaya terlihat rapi dan teratur menggunakan gaya penulisan rata kiri dan rata kanan (justified).

Penulisan dokumen dibuat sesuai kaidah bahasa yang benar

Setelah isi dokumen dibuat sesuai dengan struktur dokumen yang sudah disusun, maka penulisan dokumen tersebut harus disesuikan dengan kaidah bahasa yang benar. Dalam hal ini yang disajikan adalah kaidah penulisan bahasa Indonesia yang benar. Yang dimaksud dengan kaidah bahasa adalah adanya penggunaan bahasa sesuai dengan standar yang sudah ditentukan atau sudah baku. Tujuan penulisan dokumen ini dibuat sesuai dengan kaidah bahasa yang benar adalah untuk menjaga kesamaan persepsi dalam pemakaian bahasa, sehingga terjadi kesepahaman komunikasi dan pengertian antara komunikator dan komunikan. Sebagai contoh apabila kita menggunakan bahasa SMS pada dokumen atau penulisan formal lainnya, maka sebagian orang akan kebingungan mengartikan apa yang disampaikan dalam dokumen. Karena pada dasarnya bahasa SMS menggunakan singkatan-singkatan yang tidak formal, simbol-simbol, selipan bahasa asing (Inggris) dan ketidaklengkapan tanda baca (tanda baca dalam tulisan sangat membantu untuk mempermudah membaca mengerti akan suatu tulisan). Bahasa SMS hanya dimengerti oleh orang-orang tertentu.

 

Kaidah penulisan bahasa Indonesia yang benar dapat dilihat di bawah ini, walaupun mungkin tidak mencakup semua kaidah yang ada dalam Bahasa Indonesia.

  1. Penulisan kalimat harus sesuai dengan struktur kalimat SPO (Subjek – Predikat – Objek), atau sebagai ada tambahan Keterangan (SPOK).
  2. Penggunaan kata jamak yang menganut pola Diterangkan Menerangkan (DM), bukan Menerangkan Diterangkan (MD), karena pola Menerangkan Diterangkan dianut oleh Bahasa Inggris. Contohnya adalah:

Video Klip yang berasal dari bahasa Inggris Video Clip, seharusnya penulisannya dalam bahasa Indonesia adalah Video Clip atau klip video.

  1. Penulisan huruf kapital dengan benar, yaitu:
  • Huruf pada setiap awal kalimat harus dimulai dengan huruf besar, contohnya adalah:

Instalasi aplikasi harus dilakukan sesuai dengan prosedur yang disediakan.

  • Penulisan nama orang harus diawali dengan huruf capital, contohnya adalah:

Dokumen instalasi akan diberikan kepada bapak Maranata untuk mendapat persetujuan.

  • Penulisan nama tempat harus diawali dengan huruf capital, contohnya adalah:

Microsoft akan mengadakan seminar di Washington.

  • Penulisan nama hari, bulan diawali dengan huruf capital, contohnya adalah:

Pada hari Selasa tanggal 12 Maret, akan diadakan instalasi SQL Server 2000 di PT. Autoliv.

  • Penggunaan tanda baca dengan benar. Hal ini sudah merupakan aturan yang sangat umum dalam berbahasa, bahkan di semua bahasa, bukan hanya pada bahasa Indonesia saja, tetapi banyak pengguna bahasa yang mengabaikan hal ini. Mereka tidak menyadari bahwa pemberian tanda baca yang benar sangat membant dalam penyampaian informasi dengan benar dan tidak menimbulkan salah pengertian.Tanda baca yang dimaksud adalah tanda koma (,), tanda tanya (?), tanda titik (.), tanda seru (!), tanda kutip dua (““), dan lain lain. Contohnya adalah:

Apakah yang perlu dipersiapkan untuk melakukan instalasi Switch Server.

Penggunaan tanda titik di akhir kalimat adalah salah, seharusnya adalah tanda tanya, karena kalimat tersebut merupakan kalimat tanya.

  1. Penggunaan kata-kata bahasa Indonesia yang baku dan benar dalam dokumen. Tidak menggunakan bahasa-bahasa gaul yang digunakan dalam pergaulan sehari-hari, contohnya adalah:
  • Loe akan mendapat pengetahuan tentang bagaimana memprogram dengan baik.

Yang benar adalah: Loe à Anda

  • Setelah kebutuhan klien untuk dokumen teknis diidentifikasi, kemudian dianalisis.

Yang benar adalah: dianalisi à dianalisa

  1. Penulisan kata-kata yang benar, tidak menggunakan penulisan yang biasa digunakan dalam dunia chatting, sms dan lain-lain yang berupa singkatan-singkatan yang tidak resmi atau formal. Contohnya, adalah:

Berikut dijelaskan gmn cara menginstal Adobe Reader 6.0 n Adobe Photoshop 6.0  dengan benar.

Yang benar adalah : gmn à bagaimana

  1. Penulisan bahasa asing dalam dokumen harus dibuat italic atau huruf miring, contohnya adalah:

Sebelum melakukan instalasi firewall, terlebih dahulu dipersiapkan perangkat keras yang dibutuhkan.

Jika ternyata dalam menyusun dokumen teknis atau tulisan formal lainnya Anda bingung atau tidak tahu kata apa yang benar dalam suatu pasangan kata, contohnya antara analisis dan analisa, aktifitas dan aktifitas, atau penggunaan suatu istilah-istilah, maka Anda dapat beracuan pada:

  1. Pedoman Umum Ejaan yang Disempurnakan (EYD)
  2. Pedoman Umum Pembentukan Istilah Tata Bahasa Baku Bahasa Indonesia
  3. Kamus Besar Bahasa Indonesia (KBBI)

Selain itu juga, ada hal-hal yang perlu diperhatikan untuk menyajikan dokumen yang mudah dimengerti dan jelas. Hal-hal tersebut adalah:

  1. Penulisan kalimat dalam dokumen tidak menggunakan kalimat yang panjang-panjang. Kalimat yang panjang akan mempersulit pembaca untuk mengerti apa yang disampaikan dalam tulisan tersebut. Sebaiknya kalimat yang dibuat tidak terlalu panjang dan mengandung satu pokok pikiran. Sehingga mudah dimengerti oleh pembaca.
  2. Setiap selesai menuliskan suatu bab dan sub bab, sebaiknya disajikan kalimat pengantar, jangan angsung ke sub bab berikutnya. Atau sebaiknya jangan langsung menyajikan kalimat-kalimat yang menggunakan bullet atau numbering. Contoh untuk bagian ini dapat dilihat juga pada bagian kekeliruan yang sering terjadi dalam penulisan dokumen.
  3. Membagi struktur badan dokumen dengan penomoran yang standar. Seperti yang dilakukan dalam beberapa dokumen teknis, para penulis ada yang menulis subbab dengan penomoran menggunakan huruf. Contohnya, Bab 1 memiliki subbab A, B, dst. Hal ini tidak standar dan formal, maka gunakan Bab 1, mempunyai sub bab 1.1 lalu 1.2 dan seterusnya.

Berbicara tentang bagaimana kaidah penggunaan bahasa yang benar, yang dalam bagian ini difokuskan untuk kaidah penulisan bahasa Indonesia adalah pembahasan yang luas. Jadi dalam bagian ini hanya dibahas kaidah-kaidah yang umum saja, seperti yang telah disajikan dalam pembahasan di atas.

2) Ketrampilan Kerja

Isi dokumen teknis dibuat sesuai dengan struktur dokumen.

 

  • Mengumpulkan informasi dan contoh-contoh dokumen tentang membuat isi dokumen teknis sesuai dengan struktur dokumen.
  • Membuat isi dokumen teknis sesuai dengan struktur dokumen.

 

Format dokumen dibuat sesuai dengan standar yang dipakai.

 

  • Mencari informasi dan referensi tentang format dokumen.
  • Membuat format dokumen sesuai dengan standar yang dipakai.

 

Penulisan dokumen dibuat sesuai kaidah bahasa yang benar.

 

  • Mengumpulkan informasi dan referensi tentang kaidah bahasa yang benar.
  • Membuat penulisan dokumen sesuai kaidah bahasa yang benar.

 

 

3) Sikap Kerja

Sikap kerja ditunjukkan pada saat praktek di lingkungan kerja.

1. Mengumpulkan informasi tentang format dokumen dan kaidah penulisan bahasa Indonesia yang benar.

2. Membuat format dokumen dan penggunaan kaidah bahasa dengan benar.

 

4.5.4 Mengevaluasi dokumen teknis

 

1) Pengetahuan Kerja

 

Bagian ini menjelaskan tentang merevisi dokumen atas dasar standar dokumen dan aliran informasi, mengoreksi dokumen sebagai jaminan bagi kesempurnaan teknis dan tata bahasa, melengkapi dokumen agar memenuhi kebutuhan dokumen tenis, dan mempublikasikan agar kebutuhan penggunaan terpenuhi.

Dokumen direvisi atas dasar standar dokumen dan aliran informasi

Dokumen yang telah disusun belum boleh dikatakan siap untuk difinalisasi, tetapi harus direvisi terlebih dahulu. Revisi dokumen bisa dilakukan sampai beberapa kali. Sejarah revisi ini yang akan dituangkan ke dalam bagian Sejarah Versi. Revisi untuk dokumen teknis mencakup beberapa hal, yaitu:

  1. Aliran informasi
  2. Penggunaan etika bahasa dengan benar
  3. Penyusunan dokumen sesuai dengan standar dokumen teknis yang baik.

Tetapi dalam bagian ini kita akan membahas tentang revisi dokumen berdasarkan aliran informasi. Untuk revisi yang lainnya akan dibahas pada bagian-bagian berikutnya.

Merevisi dokumen teknis berdasarkan aliran data berarti merevisi keterhubungan atau keterkaitan dan aliran dari isi informasi yang disajikan dalam dokumen. Revisi ini dapat kita lakukan dengan memberikan pertanyaan-pertanyaan terhadap keterkaitan dan aliran isi informasi dalam dokumen. Contohnya:

  1. Apakah antara bab yang satu dengan yang lain sudah benar urutan penyajian informasinya?

Maksudnya adalah:

Kita dapat melihat contoh dari struktur dokumen yang telah disajikan pada bab sebelumnya. Dengan berdasarkan struktur tersebut, kita dapat melihat dan memprediksikan bagaimana aliran informasi yang akan disajikan dalam dokumen tenis tersebut. Dalam hal ini kita akan melihat bagian pembahasan dalm struktur dokumentasi tersebut. Pada bagian pembahasan yang disajikan terlebih dahulu adalah Persiapan Instalasi kemudian Prosedur-prosedur Instalasi. Aliran data ini tentu saja sudah benar urutannya. Karena sebelum melakukan instalasi suatu aplikasi, maka semestinya orang yang terkait mempersiapkan terlebih dahulu peralatan-peralatan dan bahan-bahan apa saja yang diperlukan dalam melakukan instalasi, sehingga dalam melakukan instalasi tidak ada lagi peralatan-peralatan atau bahan-bahan yang ketinggalan, apabila hal ini terjadi tentu saja akan mengganggu jalannya instalasi atau bahkan memungkinkan untuk melakukan instalasi aplikasi dari awal. Sedangkan kalau kita balik urutan bagian pembahasan di atas, dari Prosedur-prosedur instalasi ke persiapan instalasi, maka sudah jelas hal itu salah. Urutan itu akan mempersulit pembaca untuk memahami dan mengerti informasi yang ada dalam dokumen teknis tersebut. Sebagai contoh pada saat Anda diminta untuk melakukan sesuatu pekerjaan terlebih dahulu sebelum mengetahui persiapan-persiapan apa saja yang perlu dilakukan, tentu saja akan bingung.

 

Perbandingan di atas dalam satu bab, kita dapat lihat juga aliran informasi antar bab, contohnya, Bab 3 Pembahasan, kemudian Bab  4 Pelaporan. Dalam melakukan sesuatu pekerjaan terutama yang berhubungan dengan suatu instansi, tentu saja kita melakukan pekerjaan tersebut terlebih dahulu, kemudian melaporkan hasilnya kepada orang yang terkait.

 

  1. Apakah jika bab yang ini ditiadakan akan mengganggu keberadaan dari bab lainnya atau justru membuat dokumen tersebut tidak sesuai dengan tujuannya?

Maksudnya adalah:

Kita harus tahu terlebih dahulu tujuan sebenarnya dokumen teknis yang akan dibuat. Seperti dalam pembahasan ini dokumen yang kita buat adalah dokumen teknis instalasi. Jika kita tidak menyajikan pembahasan tentang bagaimana prosedur- prosedur instalasi aplikasi, tetapi menyajikan pembahasan tentang persiapan instalasi, maka dokumen tersebut tidak akan layak disebut dokumen instalasi aplikasi. Dokumen tersebut adalah dokumen yang cacat, yang tidak memenuhi kebutuhan klien, atau pembaca akan menganggapnya sebagai dokumen yang belum selesai. Dokumen itu tidak akan berguna dan tidak akan membantu pembaca, apalagi klien untuk menginstal aplikasi yang ditawarkan.

  1. Apakah data yang disajikan berhubungan dengan bagian yang lain atau tidak?

Maksudnya adalah:

Kita harus melihat aliran informasi secara keseluruhan, baik isi informasi yang disajikan. Jadi isi informasi harus sesuai dengan tujuan dari pembuatan dokumen teknis. Informasi yang disajikan harus mendukung dan memperkuat penyajian dokumen teknis. Contohnya adalah jika Anda membuat dokumen teknis instalasi untuk aplikasi yang hanya bisa dijalankan pada sistem operasi under windows, jangan Anda menyajikan data pendukung untuk persiapan dan prosedur instalasi aplikasi pada sistem operasi lain yang tidak didukung oleh aplikasi tersebut. Atau malah Anda justru tidak menyajikan data yang mendukung persiapan dan prosedur instalasi aplikasi pada sistem operasi under Windows.

 

Dokumen dikoreksi sebagai jaminan bagi kesempurnaan teknis dan tata bahasa.

Secara jujur, sebuah dokumen tidak akan pernah mencapai kesempurnaan, tetapi harus diusahakan untuk mencapai sempurna. Pernyataan ini benar, karena pembuatan dokumen teknis tidak hanya dipandang dari satu sisi saja, tetapi banyak sisi. Dari sisi penulisan, aliran informasi yang disajikan, tata bahasa yang digunakan, bahkan kepada siapa suatu dokumen teknis instalasi ditujukan. Kegiatan mengoreksi suatu dokumen adalah hal yang biasa dilakukan dan sering dilakukan dalam menghasilkan suatu dokumenteknis yang memenuhi standar, mnudah dimengerti dan mencakup semua kebutuhan teknis suatu instalasi.

Koreksi tata bahasa adalah hal yang penting diperhatikan dalam menghasilkan suatu dokumen yang baik. Tata bahasa akan berpengaruh kepada seberapa banyak peranan penggunaan bahasa dalam mendukung semakin mudahnya pembaca untuk mengerti apa yang disampaikan pada suatu dokumen teknis. Tata bahasa berhubungan dengan penggunaan kaidah bahasa yang baik dan benar, seperti yang telah diuraikan pada bab sebelumnya. Sebagaimana dari pengertian pasangan kata jamak dari tata bahasa, tata bahasa berarti menata penyajian bahasa sehingga mudah dimengerti tetapi memenuhi kaidah penulisan bahasa yang baik dan benar, yang disesuaikan dengan tujuan dokumen teknis instalasi tersebut (kepada siapa dokumen teknis disajika atau disusun). Sebagai contoh jika dokumen teknis instalasi akan diberikan kepada orang yang masih benar-benar awam dalam teknologi aplikasi yang didokumentasikan, maka sajikanlah tata bahasa yang sistematis, mudah dimengerti dan juga menggunakan bahasa-bahasa yang umum (jangan menggunakan bahasa-bahasa khusus atau istilah-istilah yang masih belum banyak beredar).

Sebenarnya pengoreksi yang terbaik untuk menghasilkan suatu dokumen teknis instalasi yang baik, sehingga dapat mencapai kesempurnaan teknis adalah pengguna dokumen teknis instalasi itu sendiri. Walaupun konsep ini hanya berlaku pada beberapa bagian saja dalam penyususnan dokumen teknis, seperti dalam pemenuhan kebutuhan dokumen teknis instalasi aplikasi yang berarti kesempurnaan penyajian data yang dibutuhkan oleh pengguna. Tetapi untuk beberapa bidang tentu saja si pengguna bukanlah pengoreksi yang terbaik, contohnya dalam hal informasi detail prosedur instalasi, kaidah-kaidah penggunaan bahasa yang baik dan benar, dan lain-lain.

 

Dokumen dilengkapi agar terpenuhinya kebutuhan dokumen teknis

Dokumen yang baik adalah dokumen yang menyajikan semua kebutuhan data yang dibutuhkan oleh si pengguna atau klien. Dalam suatu pembuatan dokumen tekis instalasi, penyajian informasi utama tentu saja sudah merupakan aturan yang umum dan biasa, seperti penyajian informasi tentang persiapan instalasi dan prosedur-prosedur instalasi. Tetapi terkadang ada beberapa hal-hal lain yang perlu untuk disajikan dalam dokumen teknis instalasi, dimana penulis atau penyedia dokumen teknis merasa bahwa hal-hal atau informasi tersebut tidak perlu disajikan.

Oleh karena itu, daripada penulis mengulang dokumen teknis instalasi yang sudah selesai karena kurangnya penyajian informasi yang dibutuhkan pengguna atau klien, sebaiknya penulis mengikutsertakan pengguna atau klien dalam pembuatan dokumen teknis. Tetapi penulis sendiri harus tahu sampai batas mana pengguna mengambil peran dalam pembuatan dokumen teknis instalasi. Penulis boleh mencari tahu kembali kebutuhan-kebutuhan apa lagi yang dibutuhkan oleh pengguna yang perlu disajikan dalam dokumen teknis instalasi. Penulis juga harus tahu menyaring informasi atau kebutuhan yang diberikan klien. Apakah informasi tersebut layak untuk disajikan dalam suatu dokumen teknis instalasi atau sebaliknya informasi tersebut seharusnya disajikan pada dokumen lain seperti dokumen SOP, dan lain-lain.

Kebijaksanaan untuk mengikutsertakan klien dalam pembuatan dokumen juga akan mengurangi kemungkinan pelimpahan kesalahan kepada penulis apabila klien sebagai pengguna dokumen teknis instalasi merasa bahwa informasi yang disajikan dalam dokumen teknis tidak memenuhi atau menakup semua informasi yang mereka butuhkan untuk mendukung pengetahuan mereka dalam melakukan instalasi aplikasi yang ditawarkan. Hal ini sangat penting karena dokumen teknis instalasi berhubungan dengan produk aplikasi yang dipasarkan oleh suatu bidang usaha IT. Apabila klien atau pengguna Anda puas, maka jalan perusahaan akan semakin terbuka lebar untuk mendapat klien yang lebih banyak.

 

Dokumen dipublikasikan agar terpenuhinya kebutuhan pengguna

 

Setelah dokumen teknis instalasi telah direvisi oleh pihak terkait secara keseluruhan, baik itu yang menyangkut penggunaan kaidah bahasa yang baik dan benar, isi dokumen teknis yang sesuai dengan template dan standar dokumen, struktur dokumen teknis yang dibuat atas dasar aliran informasi dan sandar dokumen yang digunakan. Maka dokumen teknis akan siap untuk dipublikasikan yang akan diberikan kepada klien atau pengguna. Dokumen teknis yang akan dipublikasi juga sudah harus memenuhi semua kebutuhan informasi yang diperlukan klien atau pengguna dalam mendukung instalasi aplikasi.

Publikasi final dukumen teknis instalasi dalam bentuk soft copy tidak harus disajikan dalam suatu dokumen Microsoft Word, tetapi justru kebanyakan para pembuat dokumen teknis meng-convertnya ke dalam suatu format yang tidak bisa diubah-ubah atau diedit oleh orang lain. Contoh formatyang paling umum digunakan adalah dalam bentuk PDF. Tujuan meng-convert dokumen ke dalam suatu format yang tidak bisa diedit adalah untuk menjaga keaslian dan keutuhan data yang disajikan dalam dokumen teknis instalasi tersebut.

 

 

2) Ketrampilan Kerja

Dokumen direvisi atas dasar standar dokumen dan aliran informasi.

 

  • Merevisi dokumen atas dasar standar dokumen dan aliran informasi.

 

Dokumen dikoreksi sebagai jaminan bagi kesempurnaan teknis dan tata bahasa.

 

  • Mencari informasi dan referensi tentang contoh-contoh dokumen, dan penggunaan tata bahasa.
  • Mengoreksi dokumen sebagai jaminan bagi kesempurnaan teknis dan tata bahasa.

 

Dokumen dilengkapi agar terpenuhinya kebutuhan dokumen teknis.

 

  • Mencari informasi tentang kriteria dokumen yang lengkap.
  • Melengkapi dokumen agar terpenuhinya kebutuhan dokumen teknis.

 

Dokumen dipublikasikan agar terpenuhinya kebutuhan pengguna

 

  • Referensi dan informasi tentang contoh-contoh dokumen, dan penggunaan tata bahasa yang dicari hasilnya benar.
  • Mempublikasikan dokumen agar terpenuhinya kebutuhan pengguna.

 

 

3) Sikap Kerja

Sikap kerja ditunjukkan pada saat praktek di lingkungan kerja.

1. Mengumpulkan informasi tentang format dokumen dan kaidah penulisan bahasa Indonesia yang benar.

2. Melakukan pengkoreksian dan pelengkapan dokumen dengan benar.

 


BAB V

SUMBER-SUMBER YANG DIPERLUKAN UNTUK PENCAPAIAN                          KOMPETENSI

 

5.1 Sumber Daya Manusia

Sumber daya manusia yang dimaksud dalam pencapaian kompetesi ini adalah orang yang terlibat dalam pencapaian kompetensi, yang terdiri dari pelatih, penilai dan teman-teman sekerja lainnya.

 

Pelatih

 

Pelatih Anda dipilih karena dia telah berpengalaman. Peran Pelatih adalah untuk :

  1. Membantu Anda untuk merencanakan proses belajar.
  2. Membimbing Anda melalui tugas-tugas pelatihan yang dijelaskan dalam tahap belajar.
  3. Membantu Anda untuk memahami konsep dan praktik baru dan untuk menjawab pertanyaan Anda mengenai proses belajar Anda.
  4. Membantu anda untuk menentukan dan mengakses sumber tambahan lain yang Anda perlukan untuk belajar Anda.
  5. Mengorganisir kegiatan belajar kelompok jika diperlukan.
  6. Merencanakan seorang ahli dari tempat kerja untuk membantu jika diperlukan.

 

Penilai

 

Penilai Anda melaksanakan program pelatihan terstruktur untuk penilaian di tempat kerja. Penilai akan :

  1. Melaksanakan penilaian apabila Anda telah siap dan merencanakan proses belajar dan penilaian selanjutnya dengan Anda.
  2. Menjelaskan kepada Anda mengenai bagian yang perlu untuk diperbaiki dan merundingkan rencana pelatihan selanjutnya dengan Anda.
  3. Mencatat pencapaian / perolehan Anda.

 

 

Teman kerja / sesama peserta pelatihan

 

Teman kerja Anda/sesama peserta pelatihan juga merupakan sumber dukungan dan bantuan. Anda juga dapat mendiskusikan proses belajar dengan mereka. Pendekatan ini akan menjadi suatu yang berharga dalam membangun semangat tim dalam lingkungan belajar/kerja Anda dan dapat meningkatkan pengalaman belajar Anda.

 

5.2.    Sumber-sumber Kepustakaan ( Buku Informasi )

 

Pengertian sumber-sumber adalah material yang menjadi pendukung proses pembelajaran ketika peserta pelatihan sedang menggunakan Pedoman Belajar ini.

Sumber-sumber tersebut dapat meliputi :

  1. Buku referensi (text book)/ buku manual servis
  2. Lembar kerja
  3. Diagram-diagram, gambar
  4. Contoh tugas kerja
  5. Rekaman dalam bentuk kaset, video, film dan lain-lain.

Ada beberapa sumber yang disebutkan dalam pedoman belajar ini untuk membantu peserta pelatihan mencapai unjuk kerja yang tercakup pada suatu unit kompetensi.

Prinsip-prinsip dalam CBT mendorong kefleksibilitasan dari penggunaan sumber-sumber yang terbaik dalam suatu unit kompetensi tertentu, dengan mengijinkan peserta untuk menggunakan sumber-sumber alternatif lain yang lebih baik atau jika ternyata sumber-sumber yang direkomendasikan dalam pedoman belajar ini tidak tersedia/tidak ada.

5.3         Daftar Peralatan dan Bahan yang digunakan

 

  1. Judul/Nama Pelatihan        :    Membuat Dokumen Teknis
  2. Kode Program Pelatihan    :    TIK.PR02.018.01

 

 

NO

UNIT

KOMPETENSI

KODE UNIT

DAFTAR PERALATAN

DAFTAR BAHAN

KETERANGAN

1.

Membuat Dokumen Teknis

TIK.PR02.018.01

- Unit PC (Personal Computer) yang digunakan sebagai media untuk menyusun dokumen teknis instalasi.

- Aplikasi Office, yang menyajikan editor untuk penulisan dokumen teknis.

 

- Buku manual penggunaan Aplikasi Office dan bagimana cara menginstal aplikasi tersebut.

- Buku informasi bagaimana menulis dokumen teknis instalasi dengan baik dan benar.

- Buku panduan etika penulisan bahasa yang benar

-CD Installer aplikasi yang akan dibuat dokumen teknis instalasinya. CD Installer ini digunakan sebagai bahan pembelajaran langkah-langkah dalam melakukan instalasi aplikasi.

 

-

 

 

 

 

 

 


DAFTAR PUSTAKA

 

  • Buku :
    • Artikel, Ikramullah, S.I.P, Beberapa Curahan Hati tentang Pemakaian Bahasa Indonesia, 2002.

 

Testimoni

artikel lainnya Membuat Dokumen Teknis TIK.PR02.018.01



bebas bayar, pembayaran mudah dan cepat, transaksi online, pembayaran tagihan dan tiket, transfer dana online

bebas bayar, pembayaran mudah dan cepat, transaksi online, pembayaran tagihan dan tiket, transfer dana online
Thursday 7 March 2013 | blog

TEKNOPRENEURSHIP adalah kemampuan menciptakan nilai tambah komersial secara konsisten dari inovasi teknologi, baik dalam produk maupun…

Tuesday 17 March 2015 | blog

MATERI PELATIHAN BERBASIS KOMPETENSI SEKTOR TEKNOLOGI INFORMASI DAN KOMUNIKASI           MENERAPKAN PRINSIP-PRINSIP…

Saturday 16 May 2015 | blog

  MATERI PELATIHAN BERBASIS KOMPETENSI SEKTOR TEKNOLOGI INFORMASI DAN KOMUNIKASI         MENERAPKAN PROGRAM…

Saturday 25 October 2014 | blog

SOAL: 1. Fungsi dari adobe photoshop adalah ... a. Mengolah gambar/foto b. Membuat aplikasi c. Mengolah…