Pertanyaan yang diberi tag «documentation»

Bagian inti dari Desain Berbasis Domain adalah penggunaan yang konsisten dari bahasa di mana-mana di seluruh sistem - dalam percakapan, kode, skema basis data, UI, tes, dll. Saya terlibat dalam sebuah proyek di mana sudah ada bahasa domain yang sudah mapan, yang ditentukan oleh organisasi standar internasional. Namun, pekerjaan yang …

10 documentation  domain-specific-languages 

Tampak bagi saya bahwa Anda tidak mungkin dapat menulis spesifikasi perangkat lunak dalam bahasa Inggris yang sepenuhnya bebas dari ambiguitas, hanya karena sifat informal bahasa alami - dan oleh karena itu spesifikasi yang benar-benar jelas harus mencakup kode yang ditulis dalam bahasa yang ditentukan secara formal. Apakah ini hasil yang …

10 documentation  specifications 

Saya salah satu pengembang yang memiliki pola pikir bahwa kode yang ditulis harus jelas dan dibaca seperti buku. NAMUN, ketika mengembangkan kode pustaka untuk digunakan orang lain, saya mencoba memasukkan sebanyak mungkin dokumentasi dalam file header; yang memunculkan pertanyaan: Apakah mendokumentasikan metode yang non-publik bahkan sepadan dengan waktu? Mereka tidak …

10 c++  documentation 

Sulit mengatakan apa yang ditanyakan di sini. Pertanyaan ini bersifat mendua, tidak jelas, tidak lengkap, terlalu luas, atau retoris dan tidak dapat dijawab secara wajar dalam bentuknya saat ini. Untuk bantuan mengklarifikasi pertanyaan ini sehingga dapat dibuka kembali, kunjungi pusat bantuan . Ditutup 8 tahun yang lalu . Saya suka …

10 agile  documentation  methodology 

Tutup. Pertanyaan ini di luar topik . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga sesuai topik untuk Rekayasa Perangkat Lunak Stack Exchange. Ditutup 6 tahun yang lalu . Perangkat lunak in-house kami telah digunakan untuk banyak pengguna dan departemen pelatihan meminta kami tip format dokumentasi …

10 design  documentation  users 

Saya telah mendokumentasikan kode saya untuk doxygen, tetapi saya tidak ingin HTML default yang diberikannya. Saya tahu saya dapat menyesuaikannya dengan memberikan CSS khusus, header, footer, dll. (Seperti yang dilakukan GNOME), dan bagaimana saya dapat menambahkan kode PHP umum ke file dan menyuruhnya menyimpannya .php, tetapi itu bukan yang saya …

10 documentation  templates  documentation-generation 

Saya bertanya-tanya apa yang seharusnya berisi dokumentasi algoritma? Tidak dapat menemukan panduan yang tepat untuk diikuti. Ada yang ingin saya sertakan ringkasan algoritma deskripsi algoritma diagram alur kode semu set input data sampel (banyak) data keluaran tes unit percobaan Klien meminta dokumentasi semacam itu untuk: Mempertahankan kepercayaan pada nomor kami …

10 java  php  algorithms  documentation  sql 

Kami memiliki banyak dokumen yang terkait dengan pengembangan perangkat lunak kami. Ini termasuk hal-hal seperti persyaratan, dokumen desain, PDF eksternal, file pelanggan, instruksi pengujian, dll. Saat ini, dokumen-dokumen ini tersebar di semua tempat (wiki, "beberapa tempat di jaringan", hard drive pengembang lokal (!), dan bahkan tempat yang lebih buruk). Apa …

10 version-control  documentation 

Ketika meninjau implementasi programmer lain dari fungsi untuk menghitung distribusi CDF normal , saya membuat saran untuk mengganti seluruh implementasi dengan fungsi bawaan Python atau menggunakan SciPy, perpustakaan ilmiah umum. Programmer lain menunjukkan bahwa keduanya math.erfc()tidak scipy.stats.norm.cdf()memberikan jaminan presisi dalam dokumentasi mereka. Oleh karena itu, saya harus lebih berhati-hati dalam …

9 documentation  math  floating-point  numeric-precision 

Seringkali saya menemukan diri saya memecahkan bug dengan menemukan jawabannya di Stack Overflow. Apakah praktik yang buruk untuk menambahkan cuplikan mengapa saya melakukan apa yang saya lakukan dan kemudian menambahkan tautan ke artikel atau halaman dari web?

9 documentation 

Saya sedang mengerjakan perpustakaan kecil yang menyediakan implementasi metrik string dasar yang terkenal. Sebagian besar untuk pendidikan saya sendiri. Jadi pengembangan terjadi setiap kali saya punya sedikit waktu luang. Karena ini saya telah mengotomatisasi sebagian besar proses sehingga saya dapat merilis versi sesering saya mengerjakannya tanpa terlalu banyak usaha. Namun …

9 java  documentation  javadocs 

Ditutup . Pertanyaan ini perlu lebih fokus . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga berfokus pada satu masalah hanya dengan mengedit posting ini . Ditutup 4 tahun yang lalu . Mengapa kita masih menanamkan deskripsi bahasa alami kode sumber (yaitu, alasan mengapa baris kode …

9 development-process  documentation  source-code 

Ini merujuk pada diskusi dalam jawaban dan komentar dari pertanyaan ini: Ada apa dengan keengganan dokumentasi di industri? . Jawabannya mengklaim bahwa "kode tidak bisa berbohong" dan karenanya harus menjadi lokasi masuk bukan dokumentasi. Beberapa komentar menunjukkan bahwa "kode bisa berbohong". Ada kebenaran di kedua sisi, setidaknya sebagian karena betapa …

9 documentation 

Saya akan meninggalkan proyek, dan sebelum saya pergi, bos saya telah meminta saya untuk mendokumentasikan kode (saya belum mendokumentasikan dengan baik). Ini bukan masalah besar, proyek ini tidak terlalu rumit. Tetapi saya menemukan tempat dalam dokumentasi saya di mana saya ingin mengatakan, "Perhatikan pada saluran XYZ bahwa ini-dan-itu terjadi." Dalam …

9 documentation  comments 

Saya tertarik melihat bagaimana orang lain melakukan ini. Terutama dalam situasi di mana beberapa klien berbeda menggunakan basis perangkat lunak yang sama dengan aturan bisnis yang sedikit berbeda. Praktik apa yang Anda gunakan untuk mendokumentasikan bagaimana segala sesuatu seharusnya berfungsi atau aturan bisnis. Pada dasarnya, jadi ketika pengembang baru datang …

9 documentation  business-rules