Pertanyaan yang diberi tag «documentation»

Dokumentasi perangkat lunak adalah teks tertulis yang menyertai perangkat lunak komputer. Ini menjelaskan bagaimana perangkat lunak beroperasi, bagaimana cara menginstalnya, bagaimana menggunakannya, dan sumber daya lainnya untuk bantuan.

4
Apakah ada upaya untuk membangun referensi HTML / JS / DOM yang diedit secara kolaboratif?
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 Mozilla Developer Network yang melakukan pekerjaan yang semakin hebat dalam …

2
Mendokumentasikan bahasa pemrograman: Referensi Manual
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 secara maksimal bagi yang baru menggunakan bahasa tersebut? Apa aspek …


6
Cara mendokumentasikan aturan bisnis
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 .. dll)


1
Apakah ada studi empiris tentang pengaruh komentar kode sumber pada kualitas perangkat lunak, rawatan dan produktivitas pengembang? [Tutup]
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 . Saya seorang penganjur mengomentari kode sumber dan mendokumentasikan produk perangkat lunak. Ini adalah pengalaman pribadi dan pengamatan …


1
Apakah pengembangan dokumentasi iteratif dimungkinkan, dan apakah ia menghasilkan dokumentasi yang efektif?
Saya memiliki proyek untuk universitas yang tidak akan saya mulai dengan segera, tetapi telah memikirkan untuk waktu yang cukup lama. Saya mengerti bahwa pengembangan proyek Universitas tidak seperti industri (saya sendiri sedang magang) sehingga situasi yang akan saya tunjukkan saat ini mungkin akan tampak agak konyol bagi pengembang perangkat lunak …

4
Bagaimana mendokumentasikan dan mengajar orang lain "dioptimalkan di luar pengakuan" kode intensif komputasi?
Kadang-kadang ada 1% kode yang cukup intensif secara komputasi yang membutuhkan jenis optimasi tingkat rendah terberat. Contohnya adalah pemrosesan video, pemrosesan gambar, dan semua jenis pemrosesan sinyal, secara umum. Tujuannya adalah untuk mendokumentasikan, dan mengajarkan teknik pengoptimalan, sehingga kode tidak menjadi tidak dapat dipelihara dan cenderung dihapus oleh pengembang yang …

5
Apa kiriman untuk diberikan kepada klien untuk aplikasi web? [Tutup]
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 telah menyelesaikan aplikasi web yang pada dasarnya dikembangkan dalam PHP dan hanyalah aplikasi …

4
Bagaimana proyek open source bisa berhasil tanpa dokumentasi tentang desain atau arsitekturnya?
Saya ingin meningkatkan keterampilan pemrograman saya dengan mempelajari proyek-proyek open source yang terkenal, tetapi saya merasa mudah tersesat hanya dengan melompat ke kode sumber mereka. Jadi saya memutuskan untuk membaca dokumentasi mereka tentang desain atau arsitektur mereka (seperti diagram UML) untuk mendapatkan ide umum tentang organisasi kode mereka terlebih dahulu. …

3
Menulis Proposal Perangkat Lunak Berkualitas Tinggi [ditutup]
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 5 tahun yang lalu . Saya telah membaca beberapa proposal untuk proyek perangkat lunak baru-baru ini dan saya sedikit …

9
Dokumentasi Kode Pertama? [Tutup]
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 2 tahun yang lalu . Adakah yang pernah mencoba membuat dokumentasi kode lengkap terlebih dahulu, sebelum benar-benar menulis …


9
Studi tentang dokumentasi kode keuntungan / kerugian produktivitas
Setelah banyak pencarian, saya gagal menjawab pertanyaan dasar yang berkaitan dengan asumsi yang dikenal di dunia pengembangan perangkat lunak: APA YANG DIKETAHUI: Menegakkan kebijakan ketat pada dokumentasi kode yang memadai (baik itu tag Doxygen, Javadoc, atau sekadar banyak komentar) menambah terlalu banyak waktu yang diperlukan untuk mengembangkan kode. TAPI: Memiliki …

Dengan menggunakan situs kami, Anda mengakui telah membaca dan memahami Kebijakan Cookie dan Kebijakan Privasi kami.
Licensed under cc by-sa 3.0 with attribution required.