MS Word secara teratur melempar kami "kejutan": tangkapan layar "pindah", tabel "mengambang", halaman kosong saat mencetak. Artikel ini adalah tentang bagaimana kami mencari pengganti MS Word (kami tidak menemukan spoiler), tetapi menemukan peluang untuk meningkatkan proses kami bekerja dengan dokumentasi secara global.
Di Uniscan Research, kami membuat produk berteknologi tinggi sebagai produk seri. Perusahaan beroperasi di sektor B2G (bisnis-ke-pemerintah) dan B2C (bisnis-ke-klien).
Departemen kami mengembangkan desain dan dokumentasi pengguna untuk produk yang sedang dikembangkan, dokumen sertifikasi, materi pemasaran, desain dan dekorasi kantor (navigasi, rambu-rambu pintu).
Dengan dokumen di sektor B2C, ada kebebasan untuk memilih format, nama, dan konten dokumentasi. Di sektor B2G, sekitar 70% dari dokumentasi yang kami kembangkan harus disiapkan sesuai dengan persyaratan ESKD dan diserahkan untuk persetujuan kepada pelanggan dalam format DOCX.
Kami mengirimkan kepada pengguna semua dokumentasi operasional dalam bentuk cetak, sehingga semua dokumen menjalani persiapan pra-pers. Dokumen kami memiliki dua format target: DOCX dan PDF.
Untuk pelaksanaan tugas kami, departemen secara tradisional telah menggunakan MS Word selama bertahun-tahun.
Dengan setiap pengeditan baru dokumen yang dikompilasi dalam MS Word, dalam sekitar setengah kasus screenshot "slide out", tabel dengan ikon "float", dan ketika dokumen dicetak, halaman kosong yang tidak terlihat muncul tiba-tiba. Operasi tata letak dokumen ini mengambil dari penulis dokumen tidak hanya waktu, tetapi juga keinginan untuk terlibat dalam kreativitas - pengembangan dokumen baru.
Selama pencarian berikutnya untuk halaman kosong tak terlihat dalam dokumen DOCX di departemen kami, muncul ide untuk mencoba alat pengembangan dokumentasi baru. Kami ingin mengurangi waktu untuk persiapan tata letak dan prepress dokumen.
Akibatnya, kami tidak dapat sepenuhnya menggunakan MS Word, tetapi dalam proses pencarian kami membangun skema baru untuk bekerja dengan dokumentasi.
Selanjutnya, saya akan mencoba memberi tahu Anda alat apa untuk bekerja dengan dokumen yang kami pertimbangkan, mengapa kami memutuskan Confluence sebagai hasilnya, masalah apa yang kami temui dan bagaimana kami dapat menyelesaikannya.
Pemilihan alat
Kami membaca artikel tentang topik alat pengembangan dokumentasi yang ada, berbicara dengan rekan kerja dari perusahaan lain. Alat-alat berikut ini tampaknya paling cocok untuk kita:
Dua alat pertama tidak cocok untuk alasan yang sama: kami membutuhkan keterampilan pemrograman yang tidak kami miliki, dan untuk membuat templat dokumen baru kami harus meminta bantuan dari seorang programmer. Transisi untuk bekerja bersama mereka, menurut ide-ide kami, akan memakan waktu sekitar enam bulan, mungkin lebih. Karena kerugian di atas, kami memutuskan untuk meninggalkan pengujian penuh alat-alat ini.
Pertemuan sejak awal sangat menyenangkan editor
WYSIWYG- . Rata-rata, penulis teknis membutuhkan waktu sekitar satu minggu untuk menguasai alat, tata letak dokumen "tidak sesuai dengan GOST" lebih mudah.
Dalam proyek B2G, PDF penting bagi kami sebagai format untuk dokumentasi pengguna. Oleh karena itu, kami segera menginstal plug-in yang sesuai untuk Confluence - Gulir Eksportir PDF. Dengannya, kami mencoba membuat templat khusus dengan parameter yang diperlukan. Kami puas dengan hasil pengujian: kami membuat salah satu dokumen dengan sejumlah besar tangkapan layar dan elemen grafik di MS Word selama sekitar satu minggu; dalam Confluence, kami berhasil menyusun dokumen yang sama dalam 2 hari dan mencapai presentasi visual yang lebih baik.
Kami juga mencoba mengonfigurasi templat untuk Eksportir Kata Gulir sedemikian rupa agar dokumen yang diterbitkan sesuai dengan semua aturan ESKD. Setelah dua hari membaca panduan Confluence dan Scroll PDF Eksportir dan mencoba untuk menyesuaikan template spesifikasi teknis saat ini, kami menyadari bahwa alat ini tidak cocok untuk pengembangan dokumen yang dieksekusi sesuai dengan persyaratan ESKD.
Jadi, misalnya, kami tidak dapat membuat pos bernomor tidak berminyak di tingkat kedua sehingga teksnya bukan tajuk, melainkan paragraf. Saya harus menulis nomor paragraf secara manual dan menggunakan gaya paragraf. Tidak mungkin untuk mengatur daftar berpoin dengan tanda hubung (hanya lingkaran, kotak), daftar bernomor digambar tanpa titik, dan daftar surat hanya dengan huruf Latin. Lekukan disesuaikan hanya secara manual.
Beberapa bulan setelah kami mulai menguasai Confluence, pengembang alat mengimplementasikan fungsi mengedit dokumen dalam format aslinya. Ini memungkinkan kami untuk menyimpan dokumen "tamu" dan membuat dokumen baru yang tidak memerlukan eksekusi ketat di tempat yang sama. File MS Word disimpan dalam Confluence sebagai lampiran, ketika diedit, mereka dibuka dan disimpan dalam MS Word di PC pengguna, dan ketika disimpan, versi baru secara otomatis diunggah ke Confluence.
Jadi kami mendapat ide untuk menggunakan Confluence sebagai alat yang secara bersamaan akan memecahkan tiga masalah:
- Menciptakan basis pengetahuan.
- Pengembangan, penyimpanan, dan pembaruan dokumentasi yang dikembangkan tidak sesuai dengan GOST.
- Penyimpanan dan pembaruan dokumentasi dikembangkan sesuai dengan GOST.
Pertemuan potensial
Harapan kami dari fungsionalitas Confluence tidak sepenuhnya terpenuhi, tetapi setelah pengujian selesai, umumnya terbentuk sikap positif terhadap alat ini. Di bawah ini kami merumuskan keunggulan utamanya untuk departemen kami:
- Kustomisasi dan dukung alat ini sendiri.
- Mudah dipelajari.
- Kemampuan untuk mengatur basis pengetahuan tentang produk perusahaan dan menyimpan semua dokumentasi yang dikompilasi dalam DOCX dan PDF di satu tempat.
- Dukungan untuk dokumen berversi.
- Kemampuan menggunakan teknologi sumber tunggal.
- Kemungkinan kerja bersama pengembang dan penulis teknis pada dokumen.
- Penyimpanan dokumen dan informasi kerja di satu tempat.
- Kemampuan untuk mengembangkan dokumen kapan saja dari mana saja di dunia.
Implementasi
Untuk menerapkan Confluence, kami memilih dua spesialis dari departemen penulis teknis yang mempelajari dan menguji kemampuan alat.
Untuk dukungan teknis yang berkelanjutan, departemen administrator sistem menugaskan kami satu spesialis. Dia dengan cepat merespons masalah teknis dan membantu memahami pengaturan dasar alat baru.
Pada saat yang sama, kami membuat kelompok kerja di departemen penulis teknis, yang tugasnya adalah merencanakan struktur penyimpanan data. Seluruh struktur server kami dibagi ke dalam kategori yang sesuai dengan jenis proyek perusahaan. Kategori, pada gilirannya, dibagi menjadi ruang-ruang oleh produk perusahaan. Kami juga mengidentifikasi kategori terpisah untuk basis pengetahuan internal.
Ketika mereka yang bertanggung jawab untuk menguji sistem mempelajari pekerjaan dalam Confluence secara mendalam, tahap pelatihan peer-to-peer dimulai. Butuh sekitar satu bulan untuk mentransfer pengetahuan ke seluruh departemen.
Masalah teknis
Implementasi Confluence secara keseluruhan berjalan cukup lancar, tetapi ada masalah.
Persiapan dan persiapan prepress dokumen
“Saya biasa melakukannya dalam MS Word dalam beberapa detik. Bagaimana melakukan hal yang sama dalam Confluence? " - kami mengajukan pertanyaan semacam itu kepada diri kami sendiri setiap hari selama seluruh periode pengujian.
Jadi, sama sekali tidak jelas bagaimana menyelaraskan isi tabel secara vertikal atau menetapkan ukuran ikon kurang dari 16 px.
Memang, rangkaian dasar fungsi pemformatan halaman dalam editor Confluence WYSIWYG jauh lebih buruk daripada MS Word, tetapi fungsionalitasnya dapat diperluas secara signifikan jika Anda masuk ke mode pengeditan kode sumber dan bekerja langsung dengan kode HTML.
Kami membaca artikel, menonton video pelatihan tentang tata letak HTML dan membagikan solusi yang kami temukan. Kami membuat halaman terpisah di Confluence, tempat kami menempatkan informasi yang berguna untuk bekerja dengan alat ini.
Pembaruan Confluence dan Plugin
Setelah pembaruan pertama plugin Gulir PDF Eksportir utama, 80% makro terbang dan struktur halaman pergi ke Confluence. Kemudian ternyata apa yang terjadi karena fungsi plugin yang baru. Di seluruh departemen, kami memulihkan struktur dokumen selama beberapa hari. Setelah itu, kami membuat rencana pembaruan untuk masa depan, yang masih kami patuhi:
- Lakukan pembaruan pada hari Jumat, ketika lapisan utama pekerjaan selama seminggu telah selesai untuk dapat menghilangkan kemungkinan masalah di akhir pekan.
- Distribusikan kepada semua pengguna sistem untuk memberi tahu mereka tentang waktu pembaruan yang direncanakan.
- Sebelum meningkatkan, buat cadangan server.
- Perbarui versi Confluence.
- Uji server, pastikan semua informasi tersedia, tautan ke sumber daya eksternal dan internal berfungsi.
- Jika Anda perlu memperbarui plugin, buat cadangan server lagi.
- Perbarui plugin Anda satu per satu plugin.
- Tes plugin segera setelah peningkatan.
Pemberitahuan Massal
Ketika aktivitas para penulis dan pengembang teknis yang bergejolak akhirnya mulai mendidih dalam Confluence, administrator menerima panggilan dari pengguna layanan. Mereka meminta untuk menyelamatkan mereka dari serangan massal dengan mengirimkan pemberitahuan tentang tindakan pengguna lain.
Secara default, pengguna hanya perlu pergi ke beberapa halaman sekali, setelah itu ia secara otomatis ditambahkan oleh sistem ke daftar pengamat dan menerima pemberitahuan setiap kali halaman ini diubah.
Selain itu, Confluence dengan senang hati melakukan buletin mingguan kepada pengguna yang mencantumkan halaman Confluence paling populer. Untungnya, masalah ini sudah banyak dibahas di Internet. Solusinya adalah dengan menonaktifkan notifikasi yang sesuai dalam pengaturan sistem:
Sekarang pengguna menerima pemberitahuan hanya jika nama mereka disebutkan dalam komentar di artikel.
Stabilitas server
Untuk menguji Confluence, kami menggunakan server Windows. Pada tahap awal, server sering "macet". Sebagian dari masalah ternyata RAM tidak cukup di server (ukuran yang disarankan adalah 11-12 GB). Masalah yang tersisa hilang ketika kami mengaktifkan pengaturan sistem yang direkomendasikan dalam kasus tersebut.
Sekarang server bekerja cukup stabil - gangguan terjadi sekitar 1 kali dalam 2 bulan. Jika terjadi kegagalan, reboot cukup untuk memperbaikinya.
Manajemen Dokumen dalam Confluence
Hari ini di Confluence penulis teknis, programmer, insinyur elektronik, QA bekerja bersama.
Kami berencana untuk sepenuhnya meninggalkan MS Word, mengembangkan dokumen secara eksklusif dalam Confluence dan mengubahnya menjadi DOCX dan PDF. Pada kenyataannya, ternyata Anda dapat melakukan tanpa proses panjang mentransfer semua dokumentasi yang ada ke format baru dan kemudian mengatur template di Scroll PDF / Word Exporters. Menurut perkiraan kami, kami butuh sekitar enam bulan untuk melakukan ini. Ternyata jauh lebih mudah untuk mentransfer semua dokumen yang dikembangkan dalam format MS Word ke Confluence dan menyimpannya di sana.
Kami memutuskan untuk tidak mengharapkan pemformatan yang luar biasa dari Confluence sesuai dengan semua persyaratan ESKD dan hanya membagi semua dokumen pengguna secara kondisional menjadi dokumen untuk "pelanggan negara" dan dokumen untuk "bukan pelanggan negara".
Yang pertama kita buat dalam format DOCX, simpan dan perbarui dalam Confluence. Kami mengembangkan yang terakhir secara langsung dalam Confluence, ekspor ke PDF jika perlu.
Berkat makro bawaan, kami menggunakan teknologi sumber tunggal dalam dokumentasi pengguna - sekarang kami tidak perlu mengubah satu parameter secara manual di beberapa versi dokumen.
WYSIWYG-editor yang nyaman memudahkan Anda untuk membuat perubahan pada dokumen yang sudah selesai - tangkapan layar, ikon, dan elemen grafis tetap ada.
Fitur pengeditan kolaboratif memungkinkan Anda berkolaborasi pada dokumen. Anda dapat berbagi dokumen dengan ahli teknis langsung di Confluence dan mendiskusikan komentarnya secara langsung, daripada menyebarkan dokumen tanpa henti melalui surat.
Untuk bekerja di luar kantor, Anda tidak perlu mengonfigurasi akses jarak jauh. Untuk dapat bekerja dari rumah, Anda hanya perlu Internet.
Confluence menawarkan kepada pengguna antarmuka halaman web yang sudah dikenal dengan kemampuan untuk mengkonfigurasi lintas-tautan dan membuka beberapa tab di browser untuk bekerja sekaligus.
Sekarang kami menyimpan semua dokumen, elemen grafis, foto perangkat, dan kami juga mempertahankan basis pengetahuan tentang produk perusahaan di satu tempat. Tidak perlu memikirkan di mana sumber gambar atau versi terbaru dari dokumen-dokumen itu.
Apa lagi yang ingin Anda lakukan
Saat ini kami sedang menyiapkan proses penyelarasan halaman Confluence menggunakan plugin Comala Workflow. Namun, plugin ini tidak berfungsi dengan lampiran MS Word. Kami mengoordinasikan dokumen-dokumen tersebut dengan bantuan komentar versi. Sekarang kami sedang mempertimbangkan opsi untuk mengatur persetujuan otomatis lampiran DOCX. Saya ingin proses persetujuan dan persetujuan digunakan bersamaan dengan halaman Confluence dan lampiran format DOCX.
Ketika kami mengatur persetujuan lampiran secara otomatis, kami akan mencoba melakukan konversi cepat dari MS Word ke PDF. Dan kemudian - mengirim dokumen ke server produk cetak kami, dari mana perusahaan percetakan mengambil dokumen untuk dicetak.
Instruksi Temukan Tiba-tiba
Kami tidak pernah berhasil meninggalkan MS Word, tetapi dalam proses mencari penggantinya, kami tiba-tiba menemukan sesuatu yang lebih. Confluence menyatukan para pengembang dari berbagai departemen, membentuk basis pengetahuan perusahaan dan menjadi gudang semua dokumen perusahaan, terlepas dari formatnya.
Perusahaan kami memiliki prinsip: dalam situasi apa pun yang tidak dapat dipahami, buat keputusan secara sistematis. Kami percaya bahwa solusi yang bergantung pada model lebih baik daripada solusi yang didasarkan pada pendapat atau intuisi ahli.
Dalam kasus Confluence, model Eric Rhys dari The Lean Startup sangat berguna. Dalam pengembangan produk, ini membantu pivot, mengubah arah pengembangan produk. Dan dalam tugas menemukan pengganti MS Word, coba alat baru yang lebih luas dan temukan manfaat terkait.
Kami berharap model yang bermanfaat bagi sesama penulis teknis!