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

同行评审 (也称为同行编辑)意味着人们聚在一起阅读、评论并推荐改进彼此的作品。同行评审是成为更好作家的好方法:它提供了批判性地看待写作的经验。同行评审也是改善写作项目的好方法。

团队写作正如其名所示,意指人们聚在一起作为一个团队来规划、编写和修订写作项目。 这种做法的另一个名称是协作写作—公开的协作写作,而不是秘密进行(那种情况下被称为剽窃)。

请注意,近年来出现了团队项目软件应用程序,其中Atlassian Confluence是一个很受欢迎的选择。它为团队成员提供了办公空间、举办团队会议的空间、文档跟踪机制等更多功能。McMurrey Associates提供了一门在线课程:技术传播课程。 Confluence 技术写作团队项目

同行评审策略

当你对其他作者的作品进行同行评审时,你需要评估作品、批评作品、提出改进建议,然后将这一切反馈给作者。作为第一次进行同行评审的评审者,你可能会对批评他人的作品感到有些不安。例如,你该如何告诉某人他的论文很无聊呢?阅读以下讨论,你会找到关于进行同行评审和传达评审意见的建议和指导。

初步会议。 在同行评审的开始,作者应向评审者提供关于写作任务的说明,以及对写作项目的目标和关注点(主题、受众、目的、情况、类型),并提醒他们注意任何问题或顾虑。作为作者,您希望提醒评审者这些问题;清楚地说明您试图做哪些事情。同样,同行评审者应要求被评审作者提供有关其目标和关注点的信息。同行评审问题应具体,如下所示:

我的虚拟机解释你理解吗?对我们最不懂技术的客户来说,这会有意义吗?
一般来说,我的写作风格是否太过专业?(我可能模仿了工程师的规范太多。)
章节标题和小节标题是否足够明确地指示接下来的内容?(我在措辞上遇到了一些困难。)
屏幕截图清晰吗?(我可能在某些截图中试图包含过多细节。)

同行评审策略。 当你评审其他人的写作时,最重要的是你应该考虑该写作的各个方面,而不仅仅是—,事实上,最不应该考虑的就是—语法、拼写和标点。如果你是第一次进行同行评审,你可能会忘记检查草稿中以下内容:

同行评审总结。 完成同行评审后,撰写一份关于您的想法、观察、印象、批评或对草稿的感受的总结是个好主意。请参见下面的同行评审者备注,其中总结了对草稿的观察。请注意备注中的以下一些细节:


同行评审结果总结说明摘录。 花一些时间将你的同行评审评论总结成对作者的简要说明。尽量保持外交辞令和同情心!

团队写作策略

如本章前面所提到的,团队写作是商业、政府、科学和技术领域的人们处理大型写作项目的常见方式之一。


NotebookLM 生成的本章信息图表

组建团队当你开始为技术写作课程的写作项目挑选团队成员时,选择背景和兴趣各异的人。正如一个多元化、全面的背景对个别作家是一个优势一样,由不同个体组成的团队也造就了一个全面的写作团队。

如果你是团队负责人,你甚至可以询问潜在团队成员的背景、兴趣、专业、才能和天赋。以下这些写作团队结合了拥有多元背景和兴趣的个体:

写作团队:红色写作斗篷
项目: 关于当前的报告 隐形技术
团队成员 背景、技能、兴趣
肖恩·S。 电气工程专业,目前在一家律师事务所做基本的办公室管理工作。
特雷西·K。 大四英语专业学生,希望这门课程能帮助提升就业前景。
桑吉夫·古普塔 计算机科学专业,目前在一家软件开发公司从事计算机图形学。
全昌妍 即将成为电气工程专业的学生,仍在提高英语语言能力
爱丽丝·B。 未宣告专业,非技术性方向,可能选错课程,没有陈述技能

规划项目。 一旦你组建了写作团队,大部分工作与自己写作时是相同的—只是每个阶段都是团队合作。具体来说,与团队开会以决定或计划以下内容:

规划阶段

  • 分析写作任务。
  • 选择一个主题。
  • 定义受众、目的和写作情况。
  • 头脑风暴并缩小主题范围。
  • 创建大纲。
  • 规划信息搜索(图书、文章等,在图书馆中)。
  • 规划一个从信息来源中记录笔记的系统。
  • 在您的写作项目中规划您希望看到的任何图形。
  • 同意样式和格式问题(请参见以下讨论)。
  • 制定项目工作计划并分配职责
    (见下文)。

捕捉你团队的档案和决策,简单易行 团队计划文档. 它可以包含团队日程中的关键日期、团队制作文件的初步大纲、格式协议、个人写作分配、用词偏好等等。下面提到了一份章程文件。它也可以纳入团队计划中。

团队写作项目中的大部分工作必须由各个团队成员独立完成。然而,如果你的团队决定将写作项目的工作分开进行,请至少遵循以下最低指导原则:

项目中可以团队合作的某些工作,你可能想要先独立完成。例如,头脑风暴、缩小范围,尤其是制定大纲,应先由每个团队成员单独完成;然后再聚在一起比较笔记。请牢记,团队动态可能无意中抑制某些想法,而较为内向的团队成员可能在小组环境中不愿意贡献他们宝贵的想法。

在您分配完项目的工作后,写一个正式的表格并分发给所有成员。


项目写作团队成员职责列表图表

项目调度与工作负载平衡。 在团队写作项目早期,设定一个关键日期的时间表。这个时间表将帮助您和团队成员稳步、有序地推进,并按时完成项目。如下例所示,时间表不仅包括项目关键阶段的完成日期,还包括会议日期、会议主题及目的。请注意这个时间表的细节:


团队写作项目的日程安排

预见问题并制定团队章程。 考虑如何解决团队项目中可能出现的典型问题,并记录你们团队对这些问题的协议。 章程文件:

审阅草稿并完成。 尽量安排尽可能多的团队书面工作的评审。你可以见面讨论彼此各个部分的初稿以及完整文档的初稿。当你们见面时,请遵循本章前面部分讨论的同伴编辑建议。 同行评审策略.

团队撰写文档的一个关键阶段是将不同团队成员撰写的各个部分汇总成一份完整的草稿。此时您可能会发现每个部分在语气、处理方式和风格上有多么不同。 你们作为一个团队必须找到一种方法来修订和编辑完整的初稿,使其读起来一致,这样就不会明显看出是由三或四个人写的。

当您完成审核和修订后,是时候进行结束工作,以便将草稿准备好提交。这项工作和您自己写文档时是一样的,只是在这种情况下,工作量可以分配。

相关信息

在Word中审查文档的真实成本. clickhelp.com

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