Pertanyaan yang diberi tag «documentation»

Salah satu tujuan utama perusahaan pengembang perangkat lunak adalah untuk meningkatkan faktor Bus mereka. Hal ini juga dianjurkan dalam ceramah yang diselenggarakan oleh Google . Itu berarti Anda harus membuat kode dan mendokumentasikan segala sesuatu dengan cara sehingga jika Anda ditabrak bus besok, proyek masih dapat dilanjutkan. Dengan kata lain, …

48 documentation  clean-code 

Tampaknya ada keengganan untuk menulis bahkan dokumentasi paling dasar. README proyek kami relatif telanjang. Bahkan tidak ada daftar dependensi yang diperbarui dalam dokumen. Adakah sesuatu yang tidak saya sadari dalam industri yang membuat programmer tidak suka menulis dokumentasi? Saya bisa mengetik paragraf dokumen jika diperlukan, jadi mengapa orang lain begitu …

47 documentation  teamwork 

Ketika mengerjakan kode, saya menghadapi banyak tantangan yang sama seperti yang dilakukan rekan tim saya, dan saya telah menulis beberapa fungsi dan kelas yang membantu, dan begitu juga mereka. Jika ada komunikasi yang baik, saya akan mendengar tentang beberapa hal hebat yang disatukan seseorang, dan enam bulan kemudian ketika saya …

43 documentation  teamwork  team  code-reuse 

Saya menemukan diri saya menulis (semoga) komentar bermanfaat dalam kode (C ++) jenis dokumentasi: The reason we are doing this is... Alasan saya menggunakan "kita" daripada "saya" adalah karena saya melakukan banyak penulisan akademis di mana "kita" sering lebih disukai. Jadi, inilah pertanyaannya. Apakah ada alasan yang baik untuk memilih …

41 documentation 

Program CS sekolah saya menghindari penyebutan pemrograman berorientasi objek, jadi saya telah melakukan beberapa bacaan sendiri untuk menambahnya - khususnya, Konstruksi Perangkat Lunak Berorientasi Objek oleh Bertrand Meyer. Meyer berulang kali menekankan bahwa kelas harus menyembunyikan sebanyak mungkin informasi tentang implementasi mereka, yang masuk akal. Secara khusus, ia berargumen berulang …

39 design  object-oriented  documentation  performance 

Apa spesifikasi teknisnya? Apakah mereka sama dengan dokumen desain. Jika tidak, apa bedanya dan beberapa contoh?

38 documentation  specifications 

Kami mencoba untuk memindahkan proses dokumentasi proyek kami dari Google Documents ke satu set repositori Git yang di-host-sendiri. Dokumen teks cukup ramah Git, karena biasanya kita tidak memerlukan pemformatan mewah, kami hanya akan mengonversi semuanya menjadi, katakanlah, multimarkdown dengan opsi untuk menyematkan LaTeX untuk kasus rumit. Tetapi spreadsheet adalah cerita …

35 version-control  documentation  tools  linux 

Perusahaan saya ingin meningkatkan manajemen data riset pasar mereka. Gaya manajemen data saat ini: "Hei Jimbo, di mana gambar WhatZit 2.0 kita? "Ya, aku ingat email tentang perusahaan itu dari orang itu, beri aku beberapa menit untuk mencari di Outlook-ku" "Siapa yang memiliki salinan terbaru dari katalog produk Pesaing Penting? …

35 documentation  cms  wiki 

Saya bekerja sebagai bagian dari tim pada aplikasi yang sudah ada yang tidak memiliki dokumentasi sebaris, juga tidak memiliki dokumentasi teknis. Karena saya telah mengerjakan berbagai laporan bug pada aplikasi, saya telah menulis semacam jejak remah roti untuk saya sendiri - nomor bug di berbagai tempat sehingga pengembang selanjutnya dapat …

35 documentation  language-agnostic  methodology 

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, …

33 development-process  documentation 

Kapan orang mulai menulis file Readme? Tampaknya hampir semua program memiliki file ini, apa pun formatnya. Apakah ada penggunaan pertama dokumen ini yang didokumentasikan?

32 documentation  terminology  history 

Ada beberapa contoh kode yang didokumentasikan dengan baik di luar sana, seperti java api. Tetapi, banyak kode dalam proyek publik seperti git dan proyek internal perusahaan tidak terdokumentasi dengan baik dan tidak terlalu ramah bagi pendatang baru. Dalam semua tugas pengembangan perangkat lunak saya, saya harus berurusan dengan kode yang …

26 programming-practices  development-process  documentation  source-code  sdlc 

Di tempat kerja saya, kami menghadapi tantangan karena "gesit" terlalu sering berarti "persyaratan yang tidak jelas, kriteria penerimaan yang buruk, semoga sukses!" Kami mencoba mengatasinya, sebagai upaya peningkatan umum. Jadi, sebagai bagian dari itu, saya mengusulkan agar kami membuat dokumen desain yang, di atas dan di luar tingkat cerita pengguna, …

25 design  agile  documentation 

Pengembangan Behavior-Driven dengan simbol skenario "Given-When-Then" simbolik akhir-akhir ini cukup populer karena kemungkinan penggunaannya sebagai objek batas untuk penilaian fungsionalitas perangkat lunak. Saya pasti setuju bahwa Gherkin , atau skrip definisi fitur mana pun yang Anda inginkan, adalah DSL yang dapat dibaca oleh bisnis , dan sudah memberikan nilai seperti …

24 documentation  bdd  documentation-generation  business-rules 

Saya telah mengerjakan proyek selama beberapa tahun sekarang, dan saya mulai mengumpulkan basis pengguna yang layak. Saya telah membuat halaman proyek dengan beberapa dokumentasi dasar, tetapi sebenarnya tidak lebih dari sebuah FAQ pada saat ini. Saya tahu bahwa saya perlu memperbaikinya sehingga lebih informatif untuk pengguna baru dan pengguna yang …

23 documentation