Saya bekerja di perusahaan sistem kontrol, di mana pekerjaan utamanya adalah SCADA dan PLC , bersama dengan hal-hal sistem kontrol lainnya.
Pengembangan perangkat lunak sebenarnya bukanlah sesuatu yang dilakukan perusahaan, terlepas dari potongan kecil di sana-sini, sampai ada keputusan untuk membuat manajemen proyek internal dan sistem penilaian.
Proyek ini telah diambil oleh orang-orang yang datang ke sini sebagai orang-orang perangkat lunak pada awalnya dan kami kebanyakan junior.
Proyek ini dimulai dari yang kecil, jadi kami hanya mendokumentasikan hal-hal seperti desain, hal-hal database dll, tetapi kami tidak pernah benar-benar menyetujui format / konvensi pengkodean.
Kami mulai menggunakan StyleCop untuk memastikan kami memiliki kode yang terdokumentasi dengan baik, tetapi saya merasa kami membutuhkan dokumen resmi untuk mengkode konvensi / praktik sehingga kami dapat melanjutkan standar yang baik dan jika ada pekerjaan pengembangan yang lebih besar di masa depan, siapa pun yang bekerja di dalamnya memiliki baseplate yang bagus.
Disinilah letak masalahnya, saya tidak tahu bagaimana menyusun dokumen untuk konvensi dan standar pengkodean, yang bisa saya pikirkan adalah contoh praktik yang baik vs buruk (misalnya kasus unta saat menamai variabel, menghindari notasi Hongaria dll) kita semua programmer yang cukup kompeten (tampaknya) tetapi kami hanya tidak memiliki piagam untuk hal semacam ini.
Untuk menjelaskannya, pertanyaan saya adalah: Apa saja aspek dan isi utama dari dokumen standar pengkodean yang baik?