Nama : Wanda Nuriza Riyana

Kelas : 1A-D3 JTK

Topik : Tugas 1 Dasar Komunikasi

Dokumentasi - Dokumentasi Teknis yang Diperlukan dalam Pengembangan Perangkat Lunak

1. ToR
ToR adalah singkatan dari Term of Reference, merupakan dokumen yang dibuat sebagai acuan awal
pelaksanaan proyek pengembangan atau pembangunan suatu software. ToR berisi kerangka awal
pekerjaan yang akan di laksanakan, berisi latar belakang, tujuan dan manfaat, gambaran proyek, tenaga
ahli yang dibutuhkan, waktu pengerjaan, dan kebutuhan pada sistem yang dibangun.
2. PIP
PIP adalah singkatan dari Project Implementation Plan, merupakan dokumen yang berisi perencanaan
yang terkait project yang akan dikerjakan. Berbeda dengan ToR, PIP beracuan pada ToR sebagai dasar
pembuatannya. Dalam PIP dijelaskan mengenai timeline pengerjaan proyek, ruang lingkup pengerjaan
sesuai dengan kesepakatan. PIP juga dapat dijadikan sebagai kontrak kesepakatan kerja antara pelaksana
dan pemberi project.
3. MoM
MoM adalah singkatan dari Minutes of Meeting, merupakan dokumen yang berisi hal-hal yang dibahas
selama rapat atau pertemuan yang membahas project dilakukan.Dalam MoM berisi siapa saja yang
menghadiri pertemuan, poin-poin penting yang di bahas terkait project, apa saja yang sudah dilakukan
dan perencanaan di hari berikutnya.
4. SRS
SRS adalah kepanjangan dari Software Requirement Specification, merupakan dokumen yang
menjelaskan mengenai spesifikasi yang dibutuhkan dalam software development seperti :
 Functionality, Software seperti apa yang dibutuhkan
 External interfaces, Bagaimana software berinteraksi dengan user,sistem pada hardware,
hardware lain, dan software lain
 Performance, Bagaimana kecepatan akses, avalaibility, responce time
 Attribute, Yang mengandung portability, correctness, maintainability, security
 Design constraints imposed on an implementation, Apa yang dibutuhkan sebagai bahasa
pemograman, integritas database, keterbatasan resource
5. SDD
SDD adalah singkatan dari Software Design Description, merupakan dokumen yang menjelaskan
gambaran user interface dari sebuah sistem. SDD berisi rancangan tampilan dari sistem
melalui reqiurement yang diperoleh.
6. UAT
UAT adalah singkatan User Acceptance Test, merupakan dokumen yang menjelaskan setiap fungsi atau
fitur yang ada dalam suatu sistem berhasil atau tidak. Dokumen UAT berisi langkah-langkah penggunaan
fitur dan errro atau tidaknya fungsi ataupun fitur dalam sistem. Dalam dokumen juga akan terdapat
skenario yang digunakan untuk melakukan testing terhadap sistem.
7.  Technical Document
Technical document merupakan hasil dokumentasi dari sebuah sistem. Dokumen ini biasanya digunakan
oleh sistem atau aplikasi yang sudah berbasis Object Oriented, dimana bagian yang terdapat dalam SRS
dan SDD sudah termasuk dalam dokumen ini.

Dokumentasi teknis dalam pengembangan perangkat lunak mencakup semua dokumen dan bahan
tertulis yang berhubungan dengan pengembangan produk perangkat lunak yang di dalamnya terdapat
dokumentasi untuk menjelaskan fungsionalitas produk, dan memungkinkan adanya komunikasi apabila
client memiliki pertanyaan yang signifikan untuk ditanyakan pada tim pengembang. Dokumentasi teknis
berfungsi sebagai panduan untuk proses pengembangan perangkat lunak, serta membantu dalam
menjelaskan produk kepada anggota tim departemen lain, seperti tim pengembang yang menjelaskan
kepada anggota pemasaran.
Jenis Dokumentasi: Tujuan utama dokumentasi yaitu memastikan bahwa tim pengembang dan
stakeholder mempunyai tujuan yang sama untuk mencapai proyek. Dokumentasi perangkat lunak dibagi
menjadi dua kategori utama, yaitu:
A. Dokumentasi Produk, menjelaskan produk yang sedang dikembangkan dan memberikan
petunjuk tentang cara melakukan berbagai tugas. Secara umum, dokumentasi produk mencakup
persyaratan, spesifikasi teknologi, logika bisnis, dan manual. Ada dua jenis utama dokumentasi
produk, yaitu:
 Dokumentasi sistem, merupakan dokumen yang menggambarkan suatu sistem dan bagian-
bagiannya termasuk dokumentasi persyaratan produk, dokumentasi desain, deskripsi arsitektur,
source code program, dan FAQs. Di dalam dokumentasi persyaratan produk terdapat poin-poin
yang menjadi rekomendasi utama yaitu; Peran dan Tanggung jawab, Sasaran tim dan Sasaran
bisnis, Latar belakang dan tujuan strategis, Asumsi (membuat daftar teknis atau asumsi bisnis
yang mungkin dimiliki tim), User story, Kriteria penerimaan, Interaksi pengguna dan desain,
Pertanyaan, Not doing (membuat daftar hal-hal yang tidak menjadi prioritas untuk direncanakan
segera dikerjakan).
 Dokumentasi pengguna, mencakup manual yang disiapkan untuk pengguna akhir produk dan
administrator sistem. Dokumentasi pengguna mencakup tutorial, panduan pengguna, manual
pemecahan masalah, instalasi, dan manual referensi. Dokumentasi yang ditujukan pengguna akhir
mencakup bagian-bagian seperti; Tanya jawab, Tutorial video, Bantuan tersemat, Portal
dukungan. Sedangkan untuk dokumen administrator sistem mencakup pemasangan dan
 pembaruan yang membantu administrator sistem dalam pemeliharaan produk. Berikut ini adalah
standar dokumen administrator sistem: Deskripsi fungsionalitas produk dan panduan admin
sistem yang menjelaskan berbagai jenis perilaku sistem di lingkungan yang berbeda dan dengan
sistem lainnya, serta harus memberikan petunjuk tentang cara menangani suatu fungsi yang
mengalami kegagalan.
B. Dokumentasi Proses, mewakili semua dokumen yang dihasilkan selama pengembangan dan
pemeliharaan yang menggambarkan prosesnya. Tujuan dari dokumentasi proses yaitu untuk
membuat pengembangan lebih terorganisir dan terencana serta membantu membuat keseluruhan
pengembangan lebih transparan dan lebih mudah untuk dikelola. Contoh umum terkait
dokumentasi proses adalah, dokumentasi proyek, rencana proyek, jadwal pengujian, laporan,
catatan pertemuan, atau bahkan korespondensi bisnis. Berikut ini adalah tipe umum dari
dokumentasi proses:
 Rencana, perkiraan, dan jadwal yang biasanya dibuat sebelum proyek dimulai dan dapat diubah
ketika produk berevolusi.
 Laporan dan metrik yang mencerminkan bagaimana waktu dan sumber daya manusia digunakan
selama pengembangan baik harian, mingguan, atau bulanan.
 Catatan, biasanya berisi beberapa informasi tentang kode, sketsa, dan ide-ide tim pengembang
tentang bagaimana menyelesaikan masalah teknis.
 Standar, bagian standar harus mencakup semua standar pengkodean dan UX yang dipatuhi oleh
tim disepanjang perkembangan proyek.

Sumber :
http://share.its.ac.id/blog/index.php?entryid=875
https://medium.com/@viviniaaguss/dokumentasi-teknis-dalam-pengembangan-perangkat-lunak-
7fc255afb96b
 Mengkritisi Informasi Visual

https://twitter.com/indonesiabaikid/status/1076452911792574464
 DESKRIPSI
Gambar diatas merupakan Poster dari sebuah Aplikasi BPJS Kesehatan Mobile bernama JKN
(Jaminan Kesehatan Nasional). Mengutip Artikel Kementrian Kesehatan Direktorat Promosi
Kesehatan dan Pemberdayaan Masyarakat, JKN adalah program Pemerintah yang bertujuan
memberikan kepastian jaminan kesehatan yang menyeluruh bagi seluruh rakyat Indonesia untuk
dapat hidup sehat, produktif dan sejahtera. Poster ini memuat gambaran atau ilustrasi mekanisme
pendaftaran peserta melalui mobile JKN. Beberapa teks informasi tercantum dalam poster tersebut.
Selain itu, di tiap sudut poster juga terdapat beberapa logo seperti logo Kominfo, Bank.id, dan logo
JKN mobile itu sendiri.

ANALISIS FORMAL
Ukuran teks judul Poster atau nama aplikasi lebih besar dibanding ukuran teks lain sehingga
terlihat jelas oleh pembaca. Informasi di dalam Poster juga disusun secara sistematis menggunakan
nomor sehingga dapat memudahkan pembaca memahami mekanisme pendaftaran peserta melalui
mobile JKN. Ilustrasi dalam Poster juga dikemas secara menarik baik dari segi warna maupun
gambar. Pencahayaan cukup, dalam artian tidak membuat poster terlalu kontras ataupun pudar.

INTERPRETASI
Di bagian pojok kiri atas, terdapat logo Kominfo yang menandakan bahwa Layanan Informasi
tersebut resmi di edarkan oleh Pemerintah melalui Menkominfo. Sedangkan di pojok kiri bawah,
terdapat logo Bank.id atau Bank Indonesia yang berarti bahwa Bank Indonesia juga telah bekerja
sama dengan BPJS dalam Pelayanan iuran JKN. Ilustrasi seseorang tengah memegang gadget
bermakna bahwa Poster tersebut berkaitan dengan Teknologi Informasi dan Komunikasi.

KRITIK DAN EVALUASI

Ukuran teks pada tahapan-tahapan pendaftaran peserta terlalu kecil sehingga perlu agak
diperbesar. Kemudian, dari Langkah ke-3 menuju 4 sebaiknya diberi tanda panah putus-putus seperti
yang lainnya, karena kesannya seperti bahan bahasan yang berbeda.