※ [本文轉錄自 EE_DSnP 看板] 作者: ric2k1 (Ric) 看板: EE_DSnP 標題: [建議] 關於 written report & README 時間: Thu Jan 24 00:02:05 2008 我將期末報告的注意事項 repost 在這邊 (並且註解於下) --- Please note that the written report accounts for 30% of the project grade. Please do spend time writing it. Please follow the following format: 簡而言之, 我覺得寫報告實在是太重要了, 你做得再好不懂得好好將他 present 出來也是白忙一場. (i) Either English or Chinese (ii) No more than 25 pages (iii) Single column (iv) 1 ~ 1.5 line spacing (v) Font: Section title: 12~16pt, BOLD Body: 12-pt Times New Romain or similar Source code or algorithm: 10~12pt Courier New or similar (vi) Place page number at the bottom of each page In your report, please include: (i) One cover page: Please specify your name, student ID, and contact information in case we need to contact you for any problem on your project (e.g. compilation error). 這個很重要, 有問題找不到人只好由我們主觀認定! (ii) Introduction(no more than 2 pages): Briefly describe what you have implemented, how you do it (in high-level, e.g. any noticeable tricks, source code structure, etc), how you test it, and the organization (outline) for the rest of this report. 這個就是 summarize 一下你做到哪裡了, 不要講得太 detail, 不要超過兩頁. (iii) Implementation: Explain your data structure (classes, functions, etc), noteworthy implementation tricks, etc. 切忌不要只是將程式碼貼上來交差了事!! 我想看到的是你到底是怎麼做的, 是否有花心力下去做, 是否有獨特的見解, 或是聰明的作法. 懂得如何安排這個章節的大綱也是很重要, 如何讓我在仔細看 code 之前就能夠 了解你做的怎麼樣. 注意!! 不是 code 寫的完整就一定會得高分 (反之亦然), 即使你無法完成要求事項, 但是只要是能將你的努力一五一十的表現出來, 還是有機會獲得高分! (iv) User Manual: Describe the usage of your program, what commands it supports, etc. 就是 "使用者操作守冊" --> 如何讓使用者能夠很快速且明瞭的明白你的 editor 應該如何使用. 這部份請不要寫太多頁! (v) Demo and experimental results: Provide at lease one working script (i.e. series of commands) that can demo the functionality of your program. Please explain it with expected results. 記得一定要附上 (如果你的程式可以跑): demo script --- 讓我們可以看到你的程式一定可以 run 的情況, 並且 repeat 你的 操作 (加分必備). 實驗結果 --- 很重要!! 寫一下你到底測過哪些東西, 結果如何等等. (vi) Conclusion: Any potential future enhancement, issues and discussion. (vii) (optional) Suggestions to this class: comments are very welcome. However, this section will not be considered for the grading of the written report. 蠻想聽聽同學們對這門課的建議! What to turn in: (i) Please put everything into a single directory. The directory name should be in the format: cpf07_<yourID>_<yourName>. For example, cpf07_b97654321_黃大頭. (ii) Include a “README” file that explains the files in your directory and provide a simple usage manual (e.g. Help message) for your program. README 就是一頁關於你的 project 目錄底下包含了哪些檔案, 如何編譯或是執行你的程式, 並且(非常)簡易的說明一下程式支援的指令或是功能. (iii) Include the written report in both original (e.g. Word, text) and PDF formats. (iv) Put the source code in a “src” subdirectory. 目的就是說請建立一些子目錄, 不要將 source code 與 Word/PDF or PPT, testcases 等等混在一起. (v) Include the executable (i.e. binary file) file. 免得我們 compile 出什麼問題, 至少還有你的執行檔參考一下! (vi) Compress everything in your directory and name it, for example, cpf07_b97654321_黃大頭.tgz. ------ davidkid註： 如果是用word或txt檔編輯然後沒有辦法轉成PDF,就附上doc/txt就好了。 或者是在EE_DSnP板上找轉檔程式處理 雖然現在1點多了,不過作業區還沒關...所以大家趕快上傳！！！ --

※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 59.121.132.15 --

※ 發信站: 批踢踢實業坊(ptt.cc) ◆ From: 123.192.152.9 ※ 編輯: davidkid 來自: 123.192.152.9 (01/24 13:22) ※ 編輯: davidkid 來自: 123.192.152.9 (01/24 13:25)