※ [本文转录自 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)