Hambatan apa yang dihadapi proses pengembangan dalam menggunakan bahasa markup teks biasa yang bertentangan dengan, misalnya, Microsoft Word? [Tutup]

Saya saat ini magang di kontraktor pemerintah dan saya merasa (secara tidak terhindarkan) merasa bahwa Word adalah standar de-facto dalam proses pengembangan perangkat lunak.

Format binernya membuatnya sangat sulit untuk berkolaborasi pada dokumen dengan cara saya terbiasa berkolaborasi pada basis kode. Penggunaan markup teks biasa (dengan bahasa seperti LaTeX, Markdown, Teks ReStructured, dll. ) Memungkinkan untuk dokumen yang ramah terhadap lingkungan yang bekerja dengan baik dengan alur kerja normal pengembang. Adapun komentar di mana bahasa tidak mendukung mereka (mis. Penurunan harga), ada banyak solusi yang ada yang memungkinkan komentar kolaboratif pada basis kode (misalnya GitHub, Bitbucket) yang dapat dengan mudah diterapkan ke file teks biasa lainnya yang berisi markup.

Saya mengerti perlunya bekerja sama dengan manajemen yang buta huruf secara teknologi mengharuskan semacam antarmuka grafis untuk semuanya, tetapi antarmuka seperti itu ada untuk sebagian besar format ini. Sebagai contoh, LaTeX memiliki 'fork' macam yang disebut LyX yang menempatkan front-end grafis ke teks biasa, seperti sintaksis seperti LaTeX. File ini, meskipun terutama grafis dalam pengeditannya, masih berbeda . (Bahkan ada komentar gaya Word.) Banyak dari solusi ini yang dapat digunakan sebagai pengganti Word, dan sebagian besar bebas atau open-source.

Namun, kami menggunakan Word bahkan untuk dokumentasi internal kami sendiri yang tidak dilihat orang lain. Kami bekerja dengan teks untuk sebagian besar karir kami --- mengapa dokumentasi begitu istimewa? Selain dari hal sepele, "Kami tidak tahu yang lebih baik dan sekarang kami terjebak di sini", pasti ada alasan yang mendukung keputusan semacam itu. Apa tantangan yang dihadapi proses pengembangan perangkat lunak dalam menggunakan dokumentasi teks-sederhana sebagai pengganti cara lain, lebih sederhana (dan kurang kuat) menulis dokumen?

Karena alasannya akan berbeda, mungkin menjawab untuk dua skenario yang berhubungan erat ini secara terpisah harus dalam urutan.

Menggunakan dokumentasi teks biasa sejak awal
Bermigrasi ke dokumentasi teks biasa dari waktu ke waktu

development-process documentation

— Sean Allred
sumber

untuk alasan independen mungkin bijaksana untuk bermigrasi ke versi kata yang lebih baru (office 2007 / 12.0 dan lebih tinggi) yang format dokumennya didasarkan pada xml. versi openoffice terbaru dan terutama libreoffice mungkin menjadi pilihan yang lebih baik - filter impor / ekspor memungkinkan integrasi tanpa batas dengan alur kerja berbasis kata ms. lebih tepatnya, bekerja dengan bahasa markup dalam pengaturan halaman menuntut tingkat abstraksi yang lebih tinggi dan penataan ide yang lebih baik sebelumnya sementara tidak mudah mendukung penulisan eksplorasi. dan tentu saja ms office ui adalah kebiasaan - tidak diperlukan pelatihan.

— collapsar

Saya tidak yakin saya setuju dengan premis Anda - Saya yakin ada banyak tempat yang menggunakan bahasa markup, karena manfaat yang Anda jelaskan.

— vaughandroid

Seperti yang ditunjukkan collapsar, dokumen kata berbasis XML sangat mudah diprogram untuk (openxml SDK, ... (Saya dapat menyarankan ClosedXML dan Novasoft.DocX untuk c #) Ketika datang dari latar belakang akademis TEX mungkin tampak hebat, tetapi jika tidak ada satu menggunakannya, itu sama saja sudah mati. Kurva belajarnya terlalu tinggi! Ibumu dan nenekmu mungkin tahu kata apa itu. Tanyakan kepada mereka tentang TEX, aku akan terkejut!

— Mvision

Dan sejauh UI bersifat intuitif, ini berlaku untuk sebagian besar alur kerja klise-level-of-normal, tetapi rusak karena hal-hal yang lebih kompleks. Lihat superuser.com/questions/620454 dan juga perhatikan bahwa cara memperbarui TOC adalah dengan memasukkan yang baru di tengahnya dan menunggu popup. Cara untuk terus-menerus mengabaikan ejaan untuk sepotong teks adalah dengan mengatur bahasa <-null. Apakah ini intuitif? Tapi ini intinya. Teks polos benar-benar memperlihatkan struktur dan isi dokumen; tidak berantakan, tidak repot.

— Sean Allred

@ Anggun Benar. Jika ada yang berharap membawa pikiran muda ke sisi gelap, komentar / jawaban untuk yang tertaut akan membantu Anda memulai. (Terutama presentasi Jubobs --- dia mengunggah arsipnya dan itu sangat bagus.)

— Sean Allred

Jawaban:

Banyak peserta dalam proses pengembangan perangkat lunak bukan pengembang, dan memerlukan kemampuan untuk berinteraksi dengan dokumentasi. Haruskah QA / Pemasaran menggunakan kata dan pengembang menggunakan sesuatu yang lain sepenuhnya? Itu akan menjadi tidak konsisten, itu akan menambah alat lain ke dalam rantai pemeliharaan dan bagian IT perusahaan mungkin tidak tahu apa yang harus dilakukan dengan file, ketika mereka tahu benar bagaimana mengelola / memelihara penyimpanan dokumen kata.

Di atas segalanya, banyak non-pengembang telah menghabiskan waktu bertahun-tahun di universitas menggunakan Microsoft Word untuk menyerahkan pekerjaan mereka, sering kali memiliki kelas pelatihan aktual hanya dalam cara menggunakan kata. Mereka tahu itu jauh lebih baik daripada alternatif. Saya hampir tidak dapat membedakannya ketika saya bekerja di Open Office vs Word, tetapi ketika saya memiliki saudara ipar saya menggunakannya untuk menghemat uang, seminggu kemudian dia meminta suaminya untuk membeli Word dan menyatakan "Sejak saya mendapat kata, saya suka laptop baru saya! " Pikirkan tentang pola pikir yang mengonfigurasikan hal-hal seperti itu, sedikit perubahan pada apa yang mereka gunakan bukanlah 'sedikit' bagi mereka.

Kata modern memungkinkan perbedaan versi, anotasi dengan pelacakan versi dan penggabungan perubahan juga. Mungkin tidak semudah penggabungan kode, tetapi saya telah melihat banyak manajer proyek melakukannya dengan mudah, jadi tentunya devs dapat mengatur untuk melakukannya juga.

Selain itu, sudah menjadi hal yang umum di antara tim dev untuk melakukan dokumentasi dalam wiki karena ia kembali ke representasi tekstual sambil tetap cukup sederhana sehingga non-pengembang dapat mengedit.

— Jimmy Hoffa
sumber

Sebagian saya tidak setuju dengan paragraf kedua Anda: Kebanyakan orang yang bekerja dengan saya tidak tahu sama sekali tentang cara menggunakan Word dan lainnya. Dan umumnya merasa tidak nyaman dengan apa pun yang tidak menyerupai sesuatu yang mereka tahu (pita siapa pun? ;-)). Ini berarti seseorang dapat menegakkan apa pun pada mereka. Sayangnya, jumlah ini cukup baik.

— nietonfir

@nietonfir wow, Sudah pengalaman saya bahwa kata adalah alat favorit setiap orang PM dan QA (baca: saja)

— Jimmy Hoffa

@ JimmyHoffa Ya, tetapi sebagian besar tidak tahu cara menggunakan Word dengan benar (mis. Indeks, subtitle gambar, tajuk halaman pertama, angka, tajuk, ...).

— nietonfir

@ JimmyHoffa: Ya, tapi berapa banyak pelatihan yang mereka dapatkan untuk itu? Dan berapa banyak fungsi Word yang benar-benar mereka gunakan? IMHO sebagian besar pengguna ini dapat dengan mudah beralih ke WordPad.

— Reinstate Monica - M. Schröder

Oh hai, @ MartinSchröder :-) Adapun WordPad, sementara sebagian besar penulis konten mungkin tidak tahu cara menggunakan MS Word untuk 'potensi' penuh, beberapa dari mereka melakukannya . Dari pengalaman saya, itu adalah sekelompok kecil pengguna daya yang mengatur dokumen (berulang-ulang) untuk pengguna yang benar-benar menambahkan sebagian besar konten. Ketika seseorang ingin menambahkan angka, komentar ditambahkan. (Pemeliharaan dokumen sebagai dokumen , kemudian, menjadi setidaknya pekerjaan paruh waktu.)

— Sean Allred

Secara pribadi saya pikir ini masalah pendidikan.

Kebanyakan orang telah tertipu untuk berpikir bahwa menggunakan alat seperti MS Word membuatnya lebih mudah untuk menghasilkan dokumen yang berkualitas, tetapi dari apa yang saya lihat itu sebenarnya membuatnya lebih sulit. Anda akhirnya harus men-debug format tanpa henti dan melawan alat Anda untuk mendapatkan hasil yang Anda inginkan.

Alat-alat seperti Scrivener memungkinkan Anda untuk sedikit lebih dekat dengan realitas dokumen tanpa harus berjuang seperti yang Anda lakukan dengan Word. Sebagian karena realisasi, WYSIWYG tidak benar-benar berfungsi dengan baik.

Di organisasi saya sendiri, semakin banyak orang yang saya gunakan untuk menggunakan MarkDown untuk sebagian besar dokumen mereka, semakin banyak orang lebih bahagia dan lebih produktif.

— aboy021
sumber

Apakah Anda benar-benar menyarankan agar "debug" LaTeX lebih mudah daripada MS Word?

— user253751

@immibis LaTeX3 tahu ini adalah masalah (bahkan LaTeX2e, tetapi gagal untuk menyampaikan maksudnya). Idealnya, tidak ada pengkodean yang dilakukan pada tingkat dokumen (terkena penulis). Semua 'debugging' dilakukan pada level kode, di mana Anda memiliki orang-orang yang terbiasa dengan bahasa melakukan pekerjaan itu. Percayalah, expl3pesan kesalahan jauh lebih membantu :)

— Sean Allred

@immibis Sebenarnya lebih mudah untuk "men-debug" LaTeX daripada MSWord. Ada kebiasaan memformat di MSWord yang tidak bisa diperbaiki oleh siapa pun tanpa memodifikasi program MSWord itu sendiri. Dalam hal ini, Anda dapat mengambil semua waktu yang Anda butuhkan untuk mempelajari LaTeX -> TeX -> C -> Assembler seberapa dalam Anda harus melakukannya. Saya tahu pengguna di luar bidang pengembangan perangkat lunak yang memiliki pengetahuan yang baik tentang LaTeX dan hal-hal seperti pstricks. Mereka memilih LaTex daripada Word setiap saat. Mereka usu. jangan melakukan banyak debugging yang kompleks, mereka hanya meminta bantuan seseorang, yang bagi mereka jarang terjadi dibandingkan dengan MSWord.

— wolfmanx

Anda benar-benar memiliki 2 pertanyaan:

Pertama: Mengapa kelompok non pengembangan tidak menggunakan LaTeX atau penurunan harga lainnya dalam proses pengembangan perangkat lunak?

Masalah dengan migrasi ke LaTeX adalah kurva pembelajaran yang dirasakan terutama ketika Anda berurusan dengan pengguna non teknis. Pengguna sudah tahu format lain dan tidak mau harus belajar metode lain untuk melakukan hal yang sama yang mereka lakukan. Mereka tahu sedikit jika ada cara untuk membedakan 2 dokumen sehingga ada sedikit nilai dalam mengubah ke format berbasis teks untuk mereka. Menjelaskan kepada seseorang bahwa Anda memiliki solusi untuk masalah yang mereka tidak tahu mereka miliki adalah penjualan yang cukup sulit.

Anda juga tidak bisa meremehkan nilai momentum ke depan. Untuk bermigrasi ke format baru, Anda benar-benar harus meyakinkan orang lain dalam rantai Anda, ada baiknya investasi untuk mempelajari sesuatu yang baru. Bahkan jika Anda tidak mengharapkan mereka untuk mengedit apa pun. Butuh waktu dan banyak upaya untuk bermigrasi ke format baru ketika format yang ada berfungsi (bahkan jika buruk).

Pertanyaan kedua: Mengapa tim saya terus menggunakan dokumen kata ketika ada opsi yang lebih baik dan mereka lebih dari mampu mempelajarinya?

Ini adalah sesuatu yang harus Anda bicarakan dengan orang-orang di tim Anda. Mungkin ada alasan yang sah bahwa mereka memilih untuk memelihara dokumen kata atau mungkin hanya karena itulah yang selalu dilakukan.

Ada biaya yang terkait dengan perubahan apa pun dan itu bisa mahal dan memakan waktu untuk memindahkan ratusan atau ribuan dokumen ke format baru. Jika Anda akan mencoba mengubah lingkungan Anda, Anda harus membuat alasan mengapa Anda harus berubah

— stoj
sumber

ini bahkan tidak berusaha menjawab pertanyaan yang diajukan, "Mengapa bahasa markup teks biasa (seperti LaTeX atau Markdown) tidak lebih populer dalam proses pengembangan perangkat lunak?"

— nyamuk

+0, tetapi setuju - ini akan lebih tepat sebagai komentar.

— Sean Allred

Setelah edit pertama pertanyaan, itu menjadi jauh lebih baik. @gnat, tampilan lain sudah beres.

— Sean Allred