Pertanyaan yang diberi tag «documentation»

Saat ini saya sedang dalam proses memperbarui dokumen desain sehingga benar dan terbaru untuk pengembang masa depan. Saat ini, dokumen hanya berfokus pada fakta-fakta, menyajikan bagaimana desainnya. Tidak ada alasan untuk setiap keputusan yang disajikan. Saya percaya bahwa penting untuk menangkap alasan agar pengembang tahu mengapa ada sesuatu seperti itu, …

13 design  documentation 

Saya mencari format dokumentasi kelas informatif untuk kelas Entitas, Logika Bisnis, dan Akses Data saya. Saya menemukan dua format berikut dari sini Format 1 ///----------------------------------------------------------------- /// Namespace: <Class Namespace> /// Class: <Class Name> /// Description: <Description> /// Author: <Author> Date: <DateTime> /// Notes: <Notes> /// Revision History: /// Name: Date: …

13 c#  documentation  comments 

Saya ingin tahu opsi apa yang tersedia untuk mendokumentasikan proyek yang telah dikembangkan, karena pengembang yang bekerja tidak menulis bahkan satu halaman dokumentasi pun. Proyek ini tidak memiliki detail lain selain banyak halaman skrip dengan fungsi yang ditulis dan dimodifikasi oleh pengembang yang mengerjakan proyek ini sejak 2 tahun terakhir. …

13 project-management  documentation 

Saya memiliki database MongoDB yang ingin saya dokumentasikan dengan baik desain skimnya. Saya tahu bahwa MongoDB adalah basis data NoSQL dan pada dasarnya adalah schemaless, tetapi saya menerapkan skema melalui aplikasi saya dan saya ingin mewakilinya dengan cara yang lebih baik daripada mencetak findOne()hasil. Saya melihat banyak orang menggunakan ER …

13 documentation  uml  nosql  mongodb  diagrams 

Ditutup . Pertanyaan ini membutuhkan detail atau kejelasan . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Tambahkan detail dan jelaskan masalahnya dengan mengedit posting ini . Ditutup 4 tahun yang lalu . RFC : Request for Comments (RFC) adalah memorandum yang diterbitkan oleh Internet Engineering Task Force (IETF) …

12 learning  documentation 

Saya seorang pengembang perangkat lunak yang bekerja di perusahaan sistem embedded. Kami memiliki Manajer Proyek, yang mengurus jadwal proyek secara keseluruhan (termasuk listrik, kualitas, perangkat lunak dan manufaktur) sehingga jadwal perangkat lunaknya sangat singkat. Kami juga memiliki Manajer Perangkat Lunak, siapa bos saya. Dia membuat saya menulis dan memelihara jadwal …

12 design  project-management  development-process  documentation 

Apakah ada istilah yang baik yang serupa tetapi berbeda dari "mencela" yang berarti bahwa metode atau API ada dalam basis kode tetapi tidak boleh digunakan karena implementasinya tidak lengkap atau kemungkinan akan berubah? (Ya, aku tahu, metode-metode itu seharusnya tidak bersifat publik, yada yada yada. Aku tidak menciptakan situasiku, aku …

12 documentation  terminology  api  documentation-generation  javadocs 

Penting : kami tidak memiliki masalah apa pun dengan dokumentasi kode sumber . Ini milik audit kode reguler dan selalu diperbarui. Masalah kami adalah dengan dokumentasi pengembang (atau, "eksternal" jika Anda mau), sedikit tips seperti blog dari programmer ke programmer yang cenderung sekali ditulis, sering tertinggal. Kami menggunakan sistem seperti …

12 project-management  agile  documentation 

Ketika kita mengatakan 'dokumentasi' untuk produk perangkat lunak, apa yang termasuk dan apa yang tidak termasuk? Misalnya, pertanyaan terbaru yang diajukan jika komentar dianggap dokumentasi? Tetapi ada banyak bidang lain yang juga merupakan pertanyaan yang valid, beberapa lebih jelas daripada yang lain: Manual (jelas) Catatan rilis? Tutorial Komentar Ada yang …

12 documentation  terminology 

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 . Perusahaan kami akan memperoleh kode sumber produk besar. Apa hal yang perlu dipertimbangkan ketika …

12 documentation  maintenance  knowledge-transfer 

Saya harus mendokumentasikan program saya untuk proyek sekolah dan kami memiliki bagian yang disebut "domain masalah" tetapi saya tidak tahu apa yang harus dibahas di bagian ini. Jadi pertanyaannya adalah: Apa yang harus didiskusikan dalam domain masalah?

12 documentation  definition 

Kami saat ini menggunakan sistem yang disebut AsciiDoc yang memungkinkan kami membuat dokumentasi dalam markup teks sederhana. Dari sana kita dapat menghasilkan beberapa format output. Kami hanya menggunakan format pdf output dan output chm. Saya bertanya-tanya apakah ada alternatif untuk chm? Apa yang saya cari adalah sesuatu yang dapat digunakan …

12 documentation  html  help-documentation 

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 6 tahun yang lalu . Saya adalah pencipta proyek open source yang berkembang. Saat ini, saya menjadi frustrasi ketika …

12 open-source  documentation 

Saya memahami perbedaan antara keduanya, tetapi saya ditanyai oleh kolega saya tentang manfaat persyaratan pelabelan sebagai fungsional atau nonfungsional (atau transisi). Kenapa repot-repot melakukannya? Dia menghabiskan apa yang dia katakan adalah dua hari melalui daftar persyaratan untuk satu proyek, dan tidak melihat manfaatnya, karena hasil akhirnya adalah menyerahkan dokumen ke …

12 documentation  project  management  requirements 

Ditutup . Pertanyaan ini didasarkan pada pendapat . Saat ini tidak menerima jawaban. Ingin meningkatkan pertanyaan ini? Perbarui pertanyaan sehingga dapat dijawab dengan fakta dan kutipan dengan mengedit posting ini . Ditutup 4 tahun yang lalu . Setiap kali saya menyelesaikan sebuah proyek, selalu ada sesuatu yang saya pelajari (jika …

12 experience  documentation  journal