buku-git icon indicating copy to clipboard operation
buku-git copied to clipboard

Peringatan - Perlu semak semula suntingan perjalanan pembacaan

Open kidino opened this issue 9 years ago • 2 comments

Setakat ini saya terima dulu pelbagai penulisan, kod-kod lain lain-lain. Tapi peringatan untuk saya, dan yang mungkin kemudian boleh membantu dari segi penyuntingan dan editorial, keseluruhan buku perlu ada kesinambungan dalam pembacaan.

kidino avatar Dec 18 '15 23:12 kidino

Menyebut tentang kesinambungan, saya terfikir sekiranya kita hasilkan satu repo sebagai contoh ataupun cukup dengan struktur direktori sebagai asas, semua penyumbang kepada buku ini boleh merujuk kepada struktur asas dan menghasilkan contoh-contoh lebih baik daripadanya. Jadi kesinambungan lebih terjamin.

Sebagai contoh, jika pada awalan topik kita berikan pembaca struktur asas seperti ini dan penyumbang gunakannya sebagai asas untuk contoh-contoh:

/
    .gitignore
    mygit/
        libs/
        tools/
            utils/
                sample.txt
            more_utils/
                sample_dir/
                    sample_file.txt
        utils/
            sample_dir/
                sample_file1.c
                ...

Penyumbang dibenarkan untuk menambah kepada struktur asas untuk menjadikan contoh lebih mudah difahami, tetapi pembuangan harus diperiksa dengan lebih teliti supaya tidak mengganggu contoh-contoh sedia ada.

Sekadar berkongsi buah fikiran.

adyromantika avatar Dec 19 '15 14:12 adyromantika

Penggunaan analogi: Bab awal mewujudkan watak Johan yang nak gunakan Git untuk Syarikat Sistem Sdn Bhd. Adakah Johan tu problem statement atau sekadar contoh untuk bab permulaan? Kalau nak kekalkan Johan dalam setiap bahagian saya rasa ok, cuma kena ada kesinambungan. Kalau tak nampak macam tergantung.

MakLaN avatar Dec 26 '15 10:12 MakLaN