Pertanyaan yang diberi tag «documentation»

Saya (santai) meneliti pendekatan semantik / ontologi untuk dokumentasi teknis, ketika saya menemukan permata ini : Pemrograman Literate dan Web Semantik adalah ide-ide dari waktu yang berbeda, yang memang memiliki koneksi. Makalah terkait, Pemrograman Literate dalam XML oleh Norman Walsh, membahas teknologi XML yang merupakan pusat web semantik, namun saya …

9 documentation  semantic-web  literate-programming 

Jika saya memiliki sepotong kode yang secara matematis atau struktural cukup rumit dan tidak dapat direduksi, bagaimana saya bisa mendokumentasikan potongan kode ini? Secara khusus, bagaimana saya dapat memastikan bahwa seseorang yang mungkin tidak memiliki keterampilan matematika atau arsitektur yang saya lakukan dapat memahaminya dari dokumentasi? Haruskah saya mendokumentasikan semua …

9 documentation 

Pertama, saya menyadari pertanyaan ini mungkin agak lama dan kabur dan saya minta maaf untuk ini. Ini mungkin adalah masalah dasar dengan nama pendek untuk siapa saja yang "mengerti", tetapi karena saya merasa kurang dalam hal ini, tolong jelaskan dengan saya dalam menggambarkan masalah. Saya sudah melakukan pemrograman dengan cara …

9 documentation  design  modeling 

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 . Kami berada dalam situasi yang buruk karena hanya memiliki sedikit dokumentasi tentang penyesuaian yang …

9 documentation 

Saya ingin menulis Javadoc dengan cara KERING. Tetapi dokumen oracle tentang Javadoc mengatakan menulis hal yang sama lagi dalam komentar metode overload. Bisakah saya menghindari pengulangan?

9 documentation  comments  dry  javadocs 

Saya mengambil aplikasi tingkat perusahaan pertama saya dan saya ingin tim saya untuk memodelkan seluruh aplikasi ASP.NET MVC C # bahkan sebelum kita mengeluarkan satu baris kode. UPDATE: Ini tidak dimaksudkan untuk menjadi diskusi filosofis tentang kapan harus mendokumentasikan / memodelkan suatu aplikasi. Harap hanya berikan jawaban untuk "bagaimana" untuk …

9 c#  asp.net-mvc  documentation  uml 

Jadi Anda memperbaiki bug, maka Anda menemukan satu yang dapat mempengaruhi modul lain dari produk perangkat lunak. Data Anda tidak cukup untuk mendukung klaim Anda tentang efek perbaikan dan Anda diminta untuk membuat dokumen analisis dampak. Apakah ada proses yang pasti tentang bagaimana melakukan ini? Apa informasi kunci yang diperlukan? …

9 project-management  documentation 

Saya mencari cara untuk meningkatkan manajemen persyaratan. Saat ini, kami memiliki dokumen Word yang diterbitkan di situs Web. Sayangnya, kami tidak dapat (setahu saya) melihat perubahan dari satu revisi ke revisi berikutnya. Saya akan sangat suka untuk melakukannya, seperti halnya wiki atau VCS (atau keduanya, seperti wiki di bitbucket!). Selain …

9 documentation  project-management  wiki  requirements 

Ini mungkin pertanyaan bodoh, tapi sudah ada di benak saya untuk sementara waktu dan saya tidak dapat menemukan jawaban yang layak di tempat lain. Saya memiliki guru yang mengatakan kita harus secara eksplisit mendaftar setiap parameter dengan deskripsi, meskipun hanya ada satu. Hal ini menyebabkan banyak pengulangan: double MyFunction(const int …

9 documentation  comments  coding-style 

Adakah yang punya saran untuk membuat diagram alur dari antarmuka web gaya REST? Untuk kepentingan menyediakan dokumentasi menyeluruh kepada pengembang bersama, saya telah mempermainkan antarmuka model untuk memodifikasi dan menghasilkan sumber daya produk: Sistem khusus ini mulai bertindak secara berbeda dengan otentikasi pengguna / sumber daya, jadi sebelum saya melakukan …

9 documentation  rest  flowchart 

Saya seorang pengembang perangkat lunak di sebuah perusahaan teknologi. Saya telah ditugaskan memimpin upaya dokumentasi untuk produk yang saya kerjakan. Tujuannya adalah untuk menghasilkan dokumentasi internal untuk pengembang, dan proyek mengalir ke sisi bisnis, di mana mencakup dokumentasi persyaratan. Proyek ini menantang. Secara khusus, saya berurusan dengan produk yang: - …

9 development-process  documentation  teamwork  planning 

Saya baru mengenal Django. Saya telah menemukan panduan topik resmi https://docs.djangoproject.com/en/1.3/ tempat yang bagus untuk belajar. Tapi sekarang saya berada di tempat di mana saya perlu referensi cepat untuk melihat metode apa yang dimiliki objek, argumen apa yang diperlukan, apa yang mengembalikan dll, seperti dokumen Python atau dokumen Java. Lebih …

8 django  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 2 tahun yang lalu . Saya sedang memproduksi dokumen "pendekatan pengembangan" bersama untuk sumber daya lepas pantai saat mereka …

8 development-process  documentation  team 

Bisakah Anda merekomendasikan templat rencana pengujian yang bagus untuk tim pengujian yang gesit? Saya tahu ada template untuk pengujian di web dan telah melihat beberapa yang ditemukan oleh mesin pencari, tetapi saya benar-benar dapat menggunakan sesuatu yang ringan dan sesuatu yang telah dicoba oleh penguji yang ahli dan dikenal bekerja …

8 testing  documentation 

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 . Seberapa berguna mengukur titik fungsi ? Kami menggunakan titik fungsi di pekerjaan baru …

8 project-management  documentation