请点击这里以获取帮助 大卫·麦克穆里 付费托管服务:
捐赠您能提供的任何小金额!
在线技术写作将继续免费。

本章介绍了一组松散定义的报告类型,它们提供经过研究的意见或建议,然后,如果你正在上技术写作课程,你也可以写一篇自己的报告。

一定要查看一下 示例报告.

一些细微的区别……

可行性报告、建议报告、评估报告、评定报告,还有谁知道其他什么,都大致做着同样的事情—提供经过仔细研究的意见,有时也包括建议。

NotebookLM-generated infographic of this chapter NotebookLM生成的本章节信息图表

典型内容:建议书和可行性报告

无论您写的是哪种可行性、建议或评估报告,无论人们怎样称之为—大多数章节及其组织结构大致相同。

结构原则的基本点在于:你不仅提供你的推荐、选择或判断,还要提供支持这些观点的数据和结论。这样,读者就可以检查你的发现、你的逻辑和你的结论,从而得出完全不同的看法。

介绍。 在引言中,说明该文档的目的是评估可行性、提出建议或评估一个主题。

技术背景。 一些推荐或可行性报告可能需要技术讨论,以使报告的其余部分具有意义。这类信息的困境在于是应该将其放在独立的部分,还是将其融入相关的比较部分。例如,关于平板电脑的性能和速度的讨论必然需要涉及一些关于RAM、兆赫和处理器的内容。你应该将这些放在一个根据性能和速度比较平板的部分吗?还是应该保持比较的整洁和简洁,仅限于比较和结论?也许所有的技术背景可以放在自己的部分—无论是在报告的前面还是在附录中。


推荐和可行性报告的示意图。 请记住,这是一种典型或常见的内容和组织模型。

情况背景。 对于许多这些报告,您需要讨论导致它们产生的问题、需求或机会。如果对此没有太多需要说明的内容,这些信息可以放在引言中。

要求与标准。 可行性和建议报告的一个关键部分是讨论您将用于做出最终决定或建议的要求。以下是一些示例:

需求可以通过几种基本方式来定义:

术语 "要求" 在这里代替 "标准。" 后者这个词有一定的模糊性;而且大多数人不确定它是单数还是复数。(从技术上讲,它是复数;"标准" 是单数,尽管 "标准" 通常同时用于单数和复数。试着在公共场合使用 "标准" 你会得到奇怪的眼光。 "标准们" 不是一个词,绝对不应该使用。)

需求部分还应讨论各个要求之间的重要性关系。想象一下典型情况,没有哪一项选择在所有比较类别中都是最佳的。一个选项更便宜;另一个功能更多;一个易用性评分更高;另一个则以更耐用而闻名。设置你的要求,使其在没有明显赢家的情况下也能决定一个"赢家"。

选项讨论。 在某些类型的可行性或建议报告中,您需要解释您是如何将选择范围缩小到报告重点关注的选项的。这通常紧接着对要求的讨论。您的基本要求可能会为您缩小选择范围。但可能还有其他考虑因素使其他选项不合格—也要对此进行解释。

此外,您可能需要提供选项本身的简要描述。不要将此与下一部分的比较混淆。在此描述部分,您将提供对这些选项的一般讨论,以便读者能够了解一些相关信息。此阶段的讨论不是比较性的。它只是对这些选项的总体介绍。在平板电脑的例子中,您可能想要对每个即将进行比较的型号给出一些简要的一般规格。

逐点比较。 可行性或建议报告中最重要的部分之一是选项的比较。请记住,您添加这一部分是为了让读者能够检查您的思路,并在需要时得出不同的结论。这应该逐个比较要点,而不是逐个选项处理。


整体对整体和逐点比较组织方法的示意图。 除非你有一个非常不寻常的话题,否则使用逐点法。

如果您在比较平板电脑,您会有一个部分比较它们的成本,另一个部分比较它们的电池功能,以此类推。您 不会 有一个部分讨论选项A的所有内容,另一个部分讨论选项B的所有内容,等等。这样做根本不有效,因为比较仍然必须在某个地方进行—可能由可怜的读者来完成。(请参见上面的示意图,以说明这两种比较方法。)

采用逐点比较的方法,每个比较部分都应该以一个结论结束,说明在该比较点上哪个选项是最佳选择。当然,直接指出一个明确的胜者并不总是容易的——你可能需要以不同的方式来限定结论,为不同的条件提供多个结论。

注意: 你什么时候会使用整体对整体的方法?这可能是因为比较无法逻辑上分解为点—类别。被比较的选项可能具有不同但不可比拟的优缺点。两个被比较的产品可能有不同但重叠的功能集。那么你更喜欢—苹果还是橙子?


个人比较部分。 注意这一部分仅比较一个点,并以一个明确阐述的结论结束。

如果你在做评估报告,显然你不会比较选项。相反,你会将被评估的事物与对其施加的要求进行比较,以及人们对它的期望。例如,首都大都会有一个超过一年免费公交运输的项目—这个项目的预期是什么?该项目是否达到了这些期望?

摘要表。 在各个比较之后,包含一个总结表,概述比较部分的结论。一些读者倾向于关注表格中的细节而不是段落。这并不意味着你可以不写段落!


摘要表。 有些读者更喜欢表格数据而不是段落中的数据。

结论。 可行性或建议报告的结论部分在某种程度上是对您在比较部分已经得出的结论的总结或重述。在这一部分,您重述每个具体的结论,例如,哪个模型的价格最好,哪个模型的电池功能最好,等等。

但这一部分必须更进一步。它必须理清所有的矛盾结论,并在某种程度上得出最终结论,即说明哪个是最佳选择。因此,结论部分首先列出 主要结论—简单的单一类别的那些。但随后必须说明 次要结论—那些平衡相互矛盾的主要结论。例如,如果一个平板电脑是最便宜的,但电池功能差,而另一个是最贵的但电池功能好,你会选择哪个,为什么?次要结论会说明这个困境的答案。

当然,结论部分以此结束。 最终结论—声明哪个选项是最佳选择。

建议或最终意见。 可行性和建议报告的最后部分陈述了建议。你可能会认为这应该很明显。通常确实如此,但请记住,有些读者可能会直接跳到建议部分,而忽略你所有的辛苦工作!此外,某些情况下可能存在最佳选择,但你可能不想推荐它。在笔记本电脑的早期历史中,它们很重且不可靠——可能有一个型号比其他型号更好,但即便如此,它也不值得拥有。

建议部分应回顾导致推荐的最重要结论,然后明确陈述推荐意见。通常情况下,您可能需要根据不同可能性推荐几个选项。这可以通过使用项目符号列表来处理,如示例所示。


初步、次要和最终结论。 请注意,在结论6中,两类比较相互权衡,更多的选择胜过较低的成本—这是一个次要结论。

在评估报告中,最后一部分将表明最终意见或判断。以下是一些可能性:

可行性和推荐报告的组织计划

这是一个很好的机会讨论这种类型报告的两种基本组织计划:


相同报告的示例大纲。 请注意执行方式中,所有关键事实、结论和建议都 " 提前 " 列出,以便读者可以快速获取它们。在大型报告中,每个附录都有标签。

推荐报告的AI提示

清单通常不会被阅读,但经过一些修改可以作为AI提示的来源。将以下内容复制,粘贴到像谷歌的Gemini这样的AI系统中,看看你可能错过了什么。

注意:所有关于数据报告或其组成部分的内容、格式、风格的参考资料都可以在这里找到。 在线技术写作教科书.

当您想使用人工智能来评估写作项目时,请介绍自己,告诉人工智能您是谁,您想要什么。给人工智能一个评估的参考点,比如在线教材。然后发布您希望人工智能在评估中检查的内容。

修改介绍以符合你的身份。

推荐报告的AI提示

你好,AI。我是大卫·麦克默里,德克萨斯州奥斯汀社区学院的网络安全学生。我请求您评估以下推荐报告。 在线教材,关于这一章 推荐报告,以及以下问题:

  1. 虽然它可以聪明和有趣,但这份推荐报告的标题是否足以表明其主题?有关详细信息,请参见 技术文档标题.
  2. 引言是否充分指明了该推荐报告的主题、目的和目标受众?是否提供了要覆盖的子主题列表以及范围的指示(未覆盖的内容)?有关详细信息,请参见 介绍.
  3. 该推荐报告是否包含技术背景部分(如有需要),情况背景(如未在引言中涵盖),要求,选项讨论,摘要表,结论列表,建议,信息来源?
  4. 该结论清单中是否包含主要结论、次要结论和最终结论?

  5. 该推荐报告是否包含足够的细节、具体内容、例子—以及支持论断和一般性说法所需的其他信息?
  6. 考虑到主题、目的和受众,这份推荐报告是否缺少任何重要内容?是否有不必要的内容?这份推荐报告中是否有技术上不正确的信息?是否缺少任何关键信息?
  7. 这份建议报告是否包含任何明显未记录的借用信息?
  8. 此推荐报告正文中的引用(信息源列表中的条目引用)是按照APA、MLA还是修改版IEEE格式?信息源列表中的条目是按照APA、MLA还是修改版IEEE格式?有关详细信息,请参见 文档:借用的信息来源.
  9. 所有表格和非装饰性图形是否都包括描述性标题(说明)和来源(如有需要)?有关详细信息,请参见 表格标题.
  10. 所有表格和非装饰性图形尽可能接近相关文本出现吗?
  11. 简要的说明性交叉参考是否出现在表格和非装饰性图形之前?有关详细信息,请参见 解释性交叉引用.
  12. 在此推荐报告的正文中是否使用了标准格式的标题和子标题?有关详情,请参见 标题.
  13. 编号垂直列表用于按要求顺序排列的列表项吗?项目符号垂直列表用于没有要求顺序的列表项吗?在所有列表之前使用引导语吗?有关详细信息,请参见 垂直列表.
  14. 直接引用是否有注明,且标注是否正确标点?所有直接引用、总结、意译是否按照APA、MLA或修改后的IEEE风格正确引用?有关详细信息,请参见 引用与归属.
  15. 这份推荐报告的文本是否没有语法、用法和标点错误?有关详细信息,请参见 常见语法、用法、拼写问题.
  16. 这份推荐报告的文字是否没有冗词和其他句子风格错误?有关详细信息,请参见 冗长,其他句式问题.
  17. 这份推荐报告能否被目标受众理解(如介绍中所示)?有关详细信息,请参阅 受众分析,看看 翻译技术内容.
  18. 人工智能,为了完成我对推荐报告的评估,请给出一个从 100 到 55 的分数。

相关信息

在线技术写作教材

推荐报告

我很感激您对这一章的想法、反应和批评: 你的回应大卫·麦克穆雷.