【1414软工助教】作业博客高分指南

博客模板

不使用 Markdown 的同学自带扣分属性。

此处给出一个用 Markdown 发表作业的模板，同学们可以在模板的基础上个性化

关于博客内容的要求，在模板的下面。

学号后3位：  
结对伙伴学号后3位：  
结对伙伴作业地址：[]()

**Coding 地址**：[]()

# 题目

[]()

# 需求分析

# 设计与实现

## 图片

## 说明

# 代码说明

## 代码1

```java

```

## 说明1

## 代码2

```python

```

## 说明2

## Git 使用截图

# 测试运行

# PSP

|经过调整的PSP表格|个人软件过程阶段|耗时估计（分钟）|实际耗时（分钟）|
|:--|:--|:--|:--|
|Estimate|填写PSP表格|||
|Learning|学习新技术|||
|Analysis|需求分析|||
|Design Spec|设计文档|||
|Design Review|设计复审|||
|Coding Standard|代码规范|||
|Design|具体设计|||
|Coding|具体编码|||
|Code Review|代码复审|||
|Test|黑箱测试（个人作业）/单元测试（结对及组队）|||
|Test Report|测试报告|||
|Size Measurement|填写PSP表格|||
|Process Improvement Plan|在博客中提出开发过程的改进计划|||

## 开发过程反思及改进计划

# 小结

## 碰到的困难

## 感受

# 照片

![]()

各部分说明

Coding 地址

请务必放在最开头！！！拉倒博客最后找地址真是累 _(:з」∠)_

题目

只给出链接，不要有其他内容，例如：
[结对编程2——单元测试](http://www.cnblogs.com/happyzm/p/6558307.html)

需求分析

不能复制作业的要求。要对作业要求再进一步地分析。

该部分对应《构建之法》第8章 需求分析 P157

设计与实现

• if (没学过 UML)
  • if (适合用流程图表达)
    • 画流程图
  • else if (适合用思维导图表达)
    • 画思维导图
  • else
    • 用文字表述
• else
  • 画 UML 图

如果以上方式都不想用，请在构建之法列出的几个方法中选择。

除了画图，还要加上文字说明。

该部分对应《构建之法》第11章 软件设计与实现 P222

代码说明

• 不对贴出的代码进行说明和没有贴出代码，这两者在助教眼中是一样的。
• 只贴关键代码！
  • 删掉你不对其说明的那部分代码
  • 贴出一大段代码会影响阅读体验。老师和助教会到你的 Coding 链接里看详细的代码，不需要你全部贴到博客。
• 给出文字版的代码，而不是截图。
  • 文字版的代码要使用编辑器的 “插入代码” 功能
  • 代码的缩进要处理好，歪来歪去的影响阅读体验
  • 如果是给出截图，则该部分得分减少一半
• 在代码的前面给出这部分代码在哪个类的哪个方法里面

记住：不说明的代码和没贴出来是一样的。

在这部分的最后，给出使用 git 提交到 Coding 的截图。
注意：如果是个人项目，截图一定要包含 push 这个动作。如果是结对项目，截图不仅要包含 push 这个动作，而且还要在 Coding 上面看到相应的 commit。

测试运行

给出测试的截图，尽量覆盖到各个方面。

由其重要的是本次作业的新要求。

PSP

PSP 最重要的一点是让使用者自己收集数据并根据这些数据做出改进。

然而经常看到很多作假的表格。明明代码规范还是原始社会的状态，却在代码规范这一栏上面写了 1.5 小时。我一问这 1.5 小时内都做了什么，吓得不敢回答……

如果你真的很厉害，能够准确地把握你的耗时，那么恭喜你。但如果你没法准确地估计耗时，还请老实地写出来。老师和助教又不会因为你的诚实而批评你或者扣你分！

小结

• 不要写虚的！写点实在些的内容。
• 碰到了什么困难？
  • 如果解决了，请说明是如何解决的；
  • 如果没有解决，请说明当前的思路，老师和助教会给你建议，引导你解决这个问题。
• 学到了什么？
  • 展开说说。避免只有一两句 “这次学了单元测试，感觉很有用” 就没了。展开说说你在学习单元测试过程中了解到的知识。
• 感受
  • 写点个人感受呗。例如：
    • 这次作业好TM难啊，特别是XX这个知识点，花了我好长时间；
    • 这次作业XX要求写得太模糊了，根本不知道老师要我们怎么做，难道要靠猜？
    • etc.
• 有什么想分享给其他同学的？
• 不要瞎写呀= =
  你说你代码做好了模块化，那就要在代码中体现出来。如果你不确定你是否在模块化上面做得足够好，你就说清楚“原来代码中，某某部分代码被我模块化为某某方法”

照片

我特别讨厌 “你以后会明白的” 这句话。

如果你能理解为什么要放照片的话，放上去挺好的。

如果你不能理解，也不想理解，那更好办。把它完全当成一个作业的要求，不给照片就扣分。实在不想给出照片，就让助教扣分嘛~不就是一两分，给他给他。

其他

发表完博客后不要直接离开，先自己浏览一遍发表完的博客，不然你都不知道你的这篇博客阅读体验有多糟糕……

因为博客园对 Markdown 的要求和一些本地编辑器不太一样，所以如果有关 Markdown 排版的问题，可以问我。