请点击这里以获得帮助 大卫·麦克默里 支付网站托管费用:
捐赠您能提供的任何小额款项!
在线技术写作将继续免费。
同行评审 (也称为同行编辑)意味着人们聚在一起阅读、评论并推荐改进彼此的作品。同行评审是成为更好作家的好方法:它提供了批判性地看待写作的经验。同行评审也是改善写作项目的好方法。
团队写作正如其名所示,意指人们聚在一起作为一个团队来规划、编写和修订写作项目。 这种做法的另一个名称是协作写作—公开的协作写作,而不是秘密进行(那种情况下被称为剽窃)。
请注意,近年来出现了团队项目软件应用程序,其中Atlassian Confluence是一个很受欢迎的选择。它为团队成员提供了办公空间、举办团队会议的空间、文档跟踪机制等更多功能。McMurrey Associates提供了一门在线课程:技术传播课程。 Confluence 技术写作团队项目
同行评审策略
当你对其他作者的作品进行同行评审时,你需要评估作品、批评作品、提出改进建议,然后将这一切反馈给作者。作为第一次进行同行评审的评审者,你可能会对批评他人的作品感到有些不安。例如,你该如何告诉某人他的论文很无聊呢?阅读以下讨论,你会找到关于进行同行评审和传达评审意见的建议和指导。
初步会议。 在同行评审的开始,作者应向评审者提供关于写作任务的说明,以及对写作项目的目标和关注点(主题、受众、目的、情况、类型),并提醒他们注意任何问题或顾虑。作为作者,您希望提醒评审者这些问题;清楚地说明您试图做哪些事情。同样,同行评审者应要求被评审作者提供有关其目标和关注点的信息。同行评审问题应具体,如下所示:
我的虚拟机解释你理解吗?对我们最不懂技术的客户来说,这会有意义吗?
一般来说,我的写作风格是否太过专业?(我可能模仿了工程师的规范太多。)
章节标题和小节标题是否足够明确地指示接下来的内容?(我在措辞上遇到了一些困难。)
屏幕截图清晰吗?(我可能在某些截图中试图包含过多细节。)
同行评审策略。 当你评审其他人的写作时,最重要的是你应该考虑该写作的各个方面,而不仅仅是—,事实上,最不应该考虑的就是—语法、拼写和标点。如果你是第一次进行同行评审,你可能会忘记检查草稿中以下内容:
- 确保您的评论是全面的。 考虑您正在审阅的草稿的所有方面,不仅仅是语法、标点和拼写。
- 多次阅读草稿,寻找各种潜在问题领域:
- 兴趣水平,适应观众
- 说服力,目的
- 内容,组织
- 讨论的清晰度
- 连贯性,使用过渡词
- 标题,引言,结论。
- 句子风格和清晰度
- 图形处理
- 注意不要发表基于个人风格的评论或批评。请将你的批评和改进建议建立在普遍认可的指导原则、概念和规则上。如果你确实发表了一个基于个人喜好的评论,请进行解释。
- 详细解释你发现的问题。不要仅仅说一份文件“似乎杂乱无章”。解释文件中什么地方杂乱无章。使用草稿中的具体细节来证明你的观点。
- 每当你批评作者草稿中的某个问题时,尽量提出一些解决方案。例如,告诉作者她的文档似乎很杂乱是不够的。解释一下如何可以解决这个问题。
- 请根据公认的指导方针、概念、原则和规则发表评论和批评。仅仅告诉一位作家两个段落应该互换是不够的。例如,说明原因:更一般的介绍性信息应该先出现。
- 避免重写您正在审核的草稿。在建议改进和修正时,不要过分重写草稿。这样会剥夺作者对文档的拥有感,并剥夺作者作为写作者学习和提高的机会。
- 找一些积极、鼓励的话来点评你正在审阅的草稿。赞美,即使是小的,通常都非常受欢迎。至少读一遍草稿,寻找做得好的地方,然后告诉作者这些优点。
同行评审总结。 完成同行评审后,撰写一份关于您的想法、观察、印象、批评或对草稿的感受的总结是个好主意。请参见下面的同行评审者备注,其中总结了对草稿的观察。请注意备注中的以下一些细节:
- 评论根据问题或错误类型进行分类—语法和用法评论在一组;更高层次的评论,如内容、组织和兴趣水平在另一组。
- 评论组的相对重要性得到了体现。同行评审者指出哪些建议“不错”可以纳入,哪些是对写作项目成功至关重要的。
- 大多数评论都包含一些简短的指导原则、规则、例子或常识。评论者不仅仅说“这是错的;改正它。”他还解释了评论的依据。
- 问题是针对作者提出的。审稿人正在仔细确认作者是否真的想要陈述或暗示某些内容。
- 审稿人对初稿给予了积极的评价,并以非对抗性、同情的方式提出批评。

同行评审结果总结说明摘录。 花一些时间将你的同行评审评论总结成对作者的简要说明。尽量保持外交辞令和同情心!
团队写作策略
如本章前面所提到的,团队写作是商业、政府、科学和技术领域的人们处理大型写作项目的常见方式之一。

NotebookLM 生成的本章信息图表
组建团队当你开始为技术写作课程的写作项目挑选团队成员时,选择背景和兴趣各异的人。正如一个多元化、全面的背景对个别作家是一个优势一样,由不同个体组成的团队也造就了一个全面的写作团队。
如果你是团队负责人,你甚至可以询问潜在团队成员的背景、兴趣、专业、才能和天赋。以下这些写作团队结合了拥有多元背景和兴趣的个体:
| 写作团队:红色写作斗篷 | |
| 项目: | 关于当前的报告 隐形技术 |
| 团队成员 | 背景、技能、兴趣 |
| 肖恩·S。 | 电气工程专业,目前在一家律师事务所做基本的办公室管理工作。 |
| 特雷西·K。 | 大四英语专业学生,希望这门课程能帮助提升就业前景。 |
| 桑吉夫·古普塔 | 计算机科学专业,目前在一家软件开发公司从事计算机图形学。 |
| 全昌妍 | 即将成为电气工程专业的学生,仍在提高英语语言能力 |
| 爱丽丝·B。 | 未宣告专业,非技术性方向,可能选错课程,没有陈述技能 |
规划项目。 一旦你组建了写作团队,大部分工作与自己写作时是相同的—只是每个阶段都是团队合作。具体来说,与团队开会以决定或计划以下内容:
规划阶段
|
捕捉你团队的档案和决策,简单易行 团队计划文档. 它可以包含团队日程中的关键日期、团队制作文件的初步大纲、格式协议、个人写作分配、用词偏好等等。下面提到了一份章程文件。它也可以纳入团队计划中。
团队写作项目中的大部分工作必须由各个团队成员独立完成。然而,如果你的团队决定将写作项目的工作分开进行,请至少遵循以下最低指导原则:
- 让每个团队成员负责文档中的一个主要部分的撰写。
- 让每个团队成员负责查找、阅读并对信息来源的平等部分进行笔记。
项目中可以团队合作的某些工作,你可能想要先独立完成。例如,头脑风暴、缩小范围,尤其是制定大纲,应先由每个团队成员单独完成;然后再聚在一起比较笔记。请牢记,团队动态可能无意中抑制某些想法,而较为内向的团队成员可能在小组环境中不愿意贡献他们宝贵的想法。
在您分配完项目的工作后,写一个正式的表格并分发给所有成员。

项目写作团队成员职责列表图表
项目调度与工作负载平衡。 在团队写作项目早期,设定一个关键日期的时间表。这个时间表将帮助您和团队成员稳步、有序地推进,并按时完成项目。如下例所示,时间表不仅包括项目关键阶段的完成日期,还包括会议日期、会议主题及目的。请注意这个时间表的细节:
- 安排了几次会议,成员们将讨论他们找到或没有找到的信息。(一位团队成员可能有另一位成员正在四处寻找的信息。)
- 几个会议已安排,以审查项目细节,具体包括主题、受众、目的、情况和大纲。当你对主题了解得更多并对项目更加确定时,你的团队可能希望改变这些细节中的一些或使它们更加具体。
- 几个初稿已安排好。团队成员至少两次进行相互评审各自的部分草稿,第二次是查看推荐的修改是否有效。 一旦完整草稿组装完成,它也会被审查两次。

团队写作项目的日程安排
预见问题并制定团队章程。 考虑如何解决团队项目中可能出现的典型问题,并记录你们团队对这些问题的协议。 章程文件:
- 工作负载不平衡。 当你作为一个团队工作时,总是有可能某个团队成员出于各种原因,承担的工作量多于或少于公平的份额。因此,找到一种方法来跟踪每个团队成员在做什么是很重要的。一个好的方法是让各个团队成员保持一个日记或日志,记录他们所做的工作类型以及花费的时间。
在项目进行和结束时,如果出现任何问题,日志应明确指出事实,并促进工作量的更公平平衡。项目结束时,团队成员可以统计在项目上花费的时间;如果有人花的时间稍微超过了她的份额,其他成员可以通过请她吃晚餐或其他类似的奖励来补偿她。同样,当项目接近尾声时,如果从日志中清楚地看出某团队成员的工作责任由于非其本身的原因而较其他成员少,他可以通过多做一些收尾工作,比如打字、校对或复印来弥补。 - 没有相关技能的团队成员。 如您在上面的团队成员技能示例描述中所见,有一名成员没有相关技能来为项目做出贡献。有时,这只是表明那个人的焦虑或缺乏参与小组项目的兴趣。当然,每个写作课程的团队成员都应该为项目贡献一定量的写作。然而,还有很多任务不需要技术知识、格式技能或敏锐的编辑眼光,例如:整理和分发团队计划、章程、会议记录;提醒团队成员截止日期和安排的会议。事实上,除了焦虑或缺乏兴趣外,自称未具备技能的团队成员可能会成为最佳团队领导者!
- 消失的团队成员。 如果你的团队不幸有一个不负责任的成员突然消失,应该制定一个应对计划,并在团队章程中记录下来。一个明显的解决方案是将该成员踢出团队,并在写作课程中通知讲师,或者在非学术组织中通知下一级管理层。
- 看似根深蒂固的团队成员之间的分歧。 团队成员在团队写作项目的某些方面是多么激烈地可以产生分歧,真是令人惊讶。制定一个计划,在你们的团队章程中,如何解决这些问题。是否应该进行投票?是否应该将问题“升级”到中立或更高级别的人士?
- 极其不一致的写作风格和格式。 因为各个部分将由不同的作者撰写,他们的写作风格可能各不相同,因此请制定一个风格指南,让团队成员列出他们对整个文档处理方式的共识。这些共识可以从高层次的内容,比如是否需要背景部分,一直到详细的细节,如何时使用斜体或加粗,以及是“click”还是“click on”。请参阅以下项目风格表的摘录。关于这些内容的讨论,请见 样式表 和 风格指南.
在你和你的团队成员撰写第一份粗略草稿之前,你不能指望能够预见每一种可能的风格和格式差异。因此,计划在审查各个部分的粗稿时,尤其是在审查完整草稿时,更新这个风格表。

写作项目风格指南摘录。 所列项目代表了团队写作人员达成的协议,以尽可能让他们的文档保持一致性。
审阅草稿并完成。 尽量安排尽可能多的团队书面工作的评审。你可以见面讨论彼此各个部分的初稿以及完整文档的初稿。当你们见面时,请遵循本章前面部分讨论的同伴编辑建议。 同行评审策略.
团队撰写文档的一个关键阶段是将不同团队成员撰写的各个部分汇总成一份完整的草稿。此时您可能会发现每个部分在语气、处理方式和风格上有多么不同。 你们作为一个团队必须找到一种方法来修订和编辑完整的初稿,使其读起来一致,这样就不会明显看出是由三或四个人写的。
当您完成审核和修订后,是时候进行结束工作,以便将草稿准备好提交。这项工作和您自己写文档时是一样的,只是在这种情况下,工作量可以分配。
相关信息
在Word中审查文档的真实成本. clickhelp.com
我很感激你对这一章的想法、反应和批评。 你的回复—大卫·麦克穆里.
