Saat ini saya menggunakan dua sistem untuk menulis dokumentasi kode (saya menggunakan C ++): Dokumentasi tentang metode dan anggota kelas ditambahkan di sebelah kode, menggunakan format Doxygen. Di server, Doxygen dijalankan pada sumber sehingga hasilnya dapat dilihat di browser web Halaman...
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...
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...
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...
Kami sedang melihat pembenahan dokumentasi di seluruh lini produk kami. Bagian dari itu termasuk manual referensi untuk bahasa pemrograman yang digunakan sebagai bagian dari sistem. Saat menulis manual referensi untuk bahasa pemrograman, apa cara terbaik untuk menyusunnya agar dapat digunakan...
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...
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...
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...
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...
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...
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
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...
W3Schools memiliki reputasi tidak lengkap, kadang-kadang salah, dan penuh dengan iklan; masih, ketika mencari untuk mencari beberapa hal atau tautan ke dokumentasi ketika menjawab pertanyaan SO, itu masih merupakan satu-satunya sumber daya lintas-browser yang berguna. Ada sumber daya lain seperti...
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...
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 . Untuk sebuah proyek,...
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...
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...
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...
Saya bertanya-tanya apa yang akan menjadi metode formal dan paling umum dilakukan untuk mendokumentasikan aturan bisnis? Juga bagaimana Anda mendokumentasikan spesifikasi UI artefak pengembangan (mis. Mendokumentasikan bidang formulir dan bagaimana tombol berperilaku pada formulir, teks info .....
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 . Saya selalu