请点击这里以获取帮助 大卫·麦克默里 支付网络托管费用:
捐赠您能提供的任何小额款项!
在线技术写作将继续免费。

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

一定要看看这个 示例报告.

一些细微的区别……

可行性报告、推荐报告、评估报告、审查报告,以及谁知道还有什么,基本上都做同样的事情—提供经过仔细研究的意见,有时还有建议。

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

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

无论你写什么可行性报告、建议书或评估报告,无论人们称之为什么—大部分章节和这些章节的组织方式大致相同。

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

介绍。 在引言中,说明该文件的目的在于确定可行性、提出建议或评估某一主题。

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


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

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

要求和标准。 可行性和建议报告的重要部分是讨论您将用于达成最终决定或建议的要求。以下是一些示例:

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

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

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

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

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

逐点比较。 可行性或建议报告中最重要的部分之一是选项的比较。请记住,您包含这一部分是为了让读者能够检查您的思路,并在他们愿意的情况下得出不同的结论。这应该逐点进行比较,而不是逐个选项进行比较。


整体与局部比较组织方法的示意图。 除非你有一个非常特别的话题,否则请使用逐点法。

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

使用逐点比较的方法,每个比较部分应以结论结束,明确指出在该具体比较点中哪个选项是最佳选择。当然,界定清晰的赢家并不总是容易的—您可能需要以各种方式限定结论,为不同条件提供多个结论。

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


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

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

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


总结表。 一些读者更喜欢表格数据,而不是段落中的数据。

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

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

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

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

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


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

在评估报告中,本节将陈述最终意见或判断。以下是一些可能性:

可行性和建议报告的组织计划

这是讨论此类型报告的两种基本组织计划的好时机:


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

推荐报告的 AI 提示

检查表通常不会被阅读,但经过一些修改可以作为AI提示的来源。将以下内容复制,粘贴到谷歌的Gemini等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. AI, 请为我的建议报告的评估分配一个从100到55的数字成绩。

相关信息

在线技术写作教科书

推荐报告

我将非常感谢你对这一章的想法、反应和批评: 你的回应大卫·麦克默里.