Saya telah secara khusus diminta untuk memberikan penjelasan atau komentar per baris (atau yang sesuai - misalnya, gambar per gambar, dll.) Yang ingin dibaca dan diikuti oleh bos saya.
Karena dia bukan seorang programmer, dia tidak bisa mengikuti kode sehingga ingin semuanya diterjemahkan ke dalam bahasa Inggris.
Adakah yang pernah diminta melakukan ini sebelumnya?
Saya telah mengomentari semua kode sumber dan menggunakan JSDoc untuk menghasilkan dokumentasi lengkap dari semua fungsi, variabel, dll ... dan termasuk contoh implementasi, dan demo kerja penuh dengan komentar di seluruh.
Apakah ada hal lain yang bisa saya lakukan untuk mengomentari kode untuk yang bukan programmer?
Ini bukan permintaan yang masuk akal, bukan?
MEMPERBARUI
Pada akhirnya, saya berhasil menjelaskan mengapa itu bukan penggunaan waktu yang baik untuk melakukan apa yang dia minta. Dia adalah pria yang masuk akal, dan hanya tidak memiliki pemahaman tentang apa yang melibatkan pekerjaan saya. Begitu dia melihat posting ini, saya pikir dia cepat mengerti bahwa itu bukan permintaan normal.
Saya memang menyediakan dokumentasi yang cocok untuk diikuti oleh programmer lain (JSDoc dan komentar inline - serta beberapa catatan tambahan tentang masalah teknis), dan diagram alir yang sangat luas dari logika utama program untuk diikuti bos saya.
Pada akhirnya, semua pihak merasa puas dan kami telah pindah.