6 Tools Pendukung Pekerjaan Document Engineer

Dokumentasi merupakan bagian yang tidak dapat diremehkan (apalagi diabaikan) dalam sebuah proses pembangunan perangkat lunak.

Dalam lingkungan Codex yang menganut metode kerja agile dan kerangka kerja berbentuk scrum, dokumentasi yang dilakukan oleh Document Engineer pun tidak terbatas pada proses yang terkait dengan Software Development Life Cycle (SDLC) saja, tetapi juga pada implementasi scrum itu sendiri.

Hal ini meliputi dokumentasi kegiatan sprint yang umumnya dilakukan dalam jangka waktu dua minggu, yang terdiri atas:

• Sprint planning
• Daily scrum
• Sprint review
• Sprint retrospective

Sebagai ‘bumbu pelengkap’ perihal Document Engineering, pada kesempatan kali ini saya ingin berbagi cerita mengenai software tools yang digunakan oleh Document Engineer untuk mempermudah pengerjaan dokumentasi sebagaimana yang diterapkan dalam lingkungan kerja Codex. Apa saja tools itu? Yuk mari disimak!

Swagger & Postman

Salah satu tugas dari seorang Document Engineer adalah membuat mockup API (Application Programming Interface) berdasarkan kontrak API yang sebelumnya telah disepakati bersama dengan para developer, serta mendokumentasikan API tersebut secara keseluruhan. Adapun tujuan dari pembuatan mockup dan dokumentasi API tersebut adalah untuk menjadi perantara antara Back-End dan Front-End developer ketika development API sedang berlangsung.

“An API loses its purpose if it is not accessible and if we do not have documentation that helps us understand it.”

Terdapat berbagai macam framework yang umum digunakan dalam pembuatan dokumentasi API, salah satunya adalah Swagger.

Pada dasarnya, Swagger adalah seperangkat spesifikasi untuk menggambarkan sebuah API sehingga dapat dikonsumsi secara baik dan mudah oleh para developer yang berinteraksi dengan API tersebut. Melalui Swagger, kita dapat melakukan request serta melihat respons dari API yang sedang dibangun. Fasilitas ini sangat membantu untuk menguji API dan membuat mock server selama siklus pembangunan perangkat lunak dengan cara yang lebih efisien.

Di samping Swagger, Document Engineer juga menggunakan Postman yang merupakan salah satu tool populer dalam pengujian API. Melalui Postman, kita dapat melakukan pengecekan API collection serta memeriksa apakah endpoint, parameter/request, dan respons yang dikeluarkan pada mockup telah sesuai dengan endpoint, parameter/request, dan respons yang berada pada sisi Postman yang telah dibuat oleh para developer.

Confluence — Gliffy

Selain membuat mockup dan dokumentasi API, seorang Document Engineer juga turut andil dalam pembuatan dokumentasi teknis, seperti:

• Software Architecture Document
• Activity Diagram
• Sequence Diagram

Activity Diagram dan Sequence Diagram sendiri merupakan pemodelan diagram UML (Unified Modeling Language) yang dibutuhkan pada tahap analisis serta desain perangkat lunak. Dokumentasi UML ini kemudian dapat digunakan sebagai media pembantu knowledge transfer antar developer dan siapa pun yang bersinggungan dengan proses pengembangan perangkat lunak terkait.

Biasanya, pembuatan model diagram UML tersebut dapat dikerjakan melalui software seperti Microsoft Visio, StarUML, LucidChart, ataupun Draw.io. Namun, para Document Engineer di Codex lebih memilih menggunakan Gliffy sebagai diagramming tool.

Gliffy merupakan sebuah plugin yang berada pada Confluence, yakni suatu content collaboration tool yang terintegrasi dengan Jira. Jira sendiri adalah sebuah project management tool utama yang digunakan Codex untuk mengakomodasi berbagai kebutuhan berjalannya project dalam squad.

Tak sebatas dokumentasi teknis, Document Engineer juga bertugas dalam membuat dokumentasi non-teknis berupa dokumentasi kegiatan sprint yang sedang berlangsung di dalam sebuah squad. Adapun dokumentasi yang dimaksud yaitu:

• Dokumentasi daily stand up
• Dokumentasi hasil sprint review
• Dokumentasi sprint retrospective

Confluence — Meeting Notes

Dalam praktik kerangka kerja scrum, suatu tim atau squad memiliki beberapa agenda tetap yang wajib dilaksanakan. Salah satunya adalah daily scrum atau biasa disebut pula dengan daily stand up. Agenda ini dilakukan setiap hari kerja dan pada waktu yang telah disepakati bersama. Agenda tersebut umumnya berlangsung selama lima belas menit, dan dihadiri oleh seorang Product Owner, para anggota squad, serta seorang Scrum Master.

Nah, pada daily stand up, adalah tugas dari Document Engineer untuk mencatat hal yang telah dikerjakan, sedang dikerjakan, dan akan dikerjakan, serta kendala yang dihadapi oleh masing-masing anggota squad dalam pengerjaan product backlog yang sebelumnya sudah disepakati pada saat sprint planning. Dokumentasi daily stand up sendiri dapat dilakukan dengan menggunakan Meeting Notes pada Confluence.

Confluence — JIRA Report

Ketika aktivitas product development yang dikerjakan oleh suatu squad telah berjalan selama satu periode sprint, maka pada akhir sprint tersebut akan diselenggarakan sebuah agenda yang disebut dengan sprint review. Dokumentasi dari sprint review ini dikerjakan oleh Document Engineer melalui tool JIRA report yang terdapat pada Confluence.

Sprint review dihadiri oleh para anggota squad, Product Owner, Scrum Master, juga stakeholder, yang bertujuan untuk melakukan review dan mendemonstrasikan hasil pekerjaan yang telah tercapai selama sprint tersebut, serta membandingkannya dengan komitmen yang telah dibuat pada awal sprint. Hasil dokumentasi dari kegiatan ini dapat digunakan sebagai bahan evaluasi dan tracking perkembangan pengerjaan product yang berhasil diselesaikan dalam suatu periode sprint.

Confluence — Retrospective

Setelah melakukan sprint review dan sebelum beranjak menuju sprint planning selanjutnya, seluruh anggota squad termasuk Product Owner dan Scrum Master berkumpul bersama untuk mengadakan sprint retrospective. Sprint retrospective merupakan sebuah agenda di mana masing-masing anggota squad mengutarakan pendapat terkait performance dirinya selama periode sprint tersebut.

Seorang Document Engineer bertanggung jawab dalam mendokumentasikan kegiatan tersebut dengan menggunakan tool Retrospective yang juga terdapat pada Confluence. Biasanya, retrospective berisi pesan introspeksi yang tercatat dalam format sad-mad-glad ataupun start-stop-continue. Tujuannya adalah agar hubungan tiap anggota dalam squad semakin solid, meningkatkan kinerja diri dalam penyelesaian backlog di sprint berikutnya, serta membuat kolaborasi antar anggota squad menjadi lebih optimal demi tercapainya tujuan dari sebuah product development itu sendiri.

Secara garis besar, demikianlah beberapa tools yang wajib diketahui dan dikuasai oleh Document Engineer dalam menjalankan pekerjaan terkait pendokumentasian secara teknis, sekaligus pendokumentasian kegiatan sprint yang berjalan dalam sebuah squad.

Seiring berjalannya waktu, perkembangan teknologi, atau perubahan budaya kerja di lingkungan Codex, tentu tidak menutup kemungkinan akan adanya penggunaan tools lain di luar beberapa tools yang telah disebutkan dalam artikel ini. Pun, tidak menutup kemungkinan akan adanya artikel mengenai topik ini di edisi selanjutnya, hehe.

Apabila kamu mempunyai masukan tentang tools lain yang bisa digunakan oleh Document Engineer, feel free to share with us ya melalui kolom respons di bawah! :)