Tracking Technical Writing Tasks When Working with Other Departments

与其他部门合作时跟踪技术写作任务

2020-12-02 23:20 clickhelp

本文共727个字,阅读需8分钟

阅读模式 切换至中文

Being a technical writer means getting writing tasks from other departments, not only your manager. It's not like you don't have enough on your plate already, but since you are really good at creating documentation, helping other teams out seems only natural. So, cross-team communication is an important part of this role. What's more interesting is that different teams will ask you to do different sorts of tasks. This you should be prepared for. For example, marketing will mostly assign strictly writing tasks to you. They won't require any feedback, just writing the text. Developers, as a rule, expect something different from you. When they ask to create technical documentation, they might expect a usability review and a list of bugs. How do you deal with all these tasks and stay on top of your game? Well, there are ways! Keep reading to learn what they are. Create a Content Request Submission Form or Checklist To get something done right and timely, you will need certain information about the task. When a person comes to you with a content request, they have requirements, naturally. However, it is great to have your own checklist. You can send it out to be filled, you can just ask additional questions and fill it out yourself. Some ideas of things to be included into a content request form: Title General description Goals Target audience Length Format Reference materials Due date This way, you will be able to make sure that you've got everything, all the details you need to start working on the assignment. Always Track Your Writing Tasks Progress It is likely that whoever asks you to write something will have a document to keep track of the process. This might be enough for some, but I advise you to use a task tracking tool to control all kinds of content requests you get from other teams. This way, it is going to be so much easier not only to see progress for each task, but also to be able to quickly access the relevant information and comments. Also, you will get a nice birds-eye view of the work you need to finish with the due dates. This will help you plan things more effectively and produce great examples of technical communication. Surely, this is the most convenient way to track this data. Your manager will see your workflow and engagement. This tool can also come in handy when your manager asks you about the scope of work you are doing for different teams - you can reference it easily. If you do not use a tool like that - you can create at least a table. But, of course, that is less convenient. Here's what I recommend including in this document: Who and when asked you to create content Reference links (e.g., a Jira ticket) Status Due date Notes Actually, using a table is not the best solution here. It may only be a temporary way out. Use Convenient Tools Let's assume you are successfully keeping track of all the content creation tasks and using a checklist to get necessary task details quickly. Great! Now, it is time to deliver the content. I recommend using technical writing software for any assignments, even when they are not connected with the global projects you are working on. This has multiple benefits, like: Everything is stored in one place You can use any popular format for the final output You can use the review workflow and other team collaboration features Technical writing software will be perfect for any type of writing with features like a robust text editor, version history, spell checking, etc. Of course, using technical writing tools may be a bit too much when we talk about marketing texts one-page long. But no other substantial task can do without tools to create content. Documentation software helps to organize the process of content creation for different departments. Conclusion Don't let tasks pile up and make a mess of your work hours! With the help of the advice above, you will be able to structure working with assignments you get from different departments. Make your workflow consistent with the help of special tools and services. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
做一名技术文档撰写人意味着不仅会从你的经理那里得到写作任务,还会从其他部门获取写作任务。这并不是说你手头没有足够的工作,但是既然你真的很擅长编写文档,那么帮助其他团队也就理所当然。因此,跨团队沟通是这个角色的重要组成部分。更有趣的是,不同的团队会要求你做不同种类的任务。你应该为此有所准备。例如,市场营销大多会给你分配严格的写作任务。他们不需要任何反馈,只需要撰写文本。开发人员的期望通常不同于你。他们要求编写技术文档,可能只是期望得到一份可用性审查和漏洞列表。 你如何处理所有这些任务并在写作中保持领先呢?好吧,有办法的!继续阅读,一探究竟。 创建内容要求提交表或清单 为了及时正确地完成某项任务,你需要有关该任务的某些信息。当一个人带着内容请求来找你,他们自然也有要求。然而,拥有自己的清单是很棒的。你可以发送出去让他人填写,也可以只问额外问题,然后自己填写。 内容要求表中应包含的一些内容: 标题 概括说明 目标 目标受众 长度 格式 参考材料 截止日期 这样,你就能确保自己已经掌握了开始工作所需的一切、所有细节。 始终跟踪你的写作任务进度 不管是谁让你写什么东西,都很可能会有一个文档来跟踪写作过程。这对某些人来说可能已经足够了,但我建议你使用任务跟踪工具来管理你从其他团队获得的各种内容要求。通过这种方式,你不仅可以更容易地查看每项任务的进度,而且可以快速访问相关信息和评论。此外,你还可以鸟瞰自己需要在截止日期前完成的工作。这将帮助你更有效地作出计划,并创造技术交流非常好的例子。 当然,这是跟踪这些数据最方便的方法。你的经理会看到你的工作流程和参与度。当经理询问你为不同团队所做的工作范围时,这个工具也可以派上用场--你可以很容易地以之作为参考。如果不使用类似的工具,你至少可以创建一个表。不过,这显然不太方便。 以下是我建议在本文档中包括的内容: 何人和何时要求你创建内容 参考链接(例如,Jira票证) 状况 截止日期 备注 实际上,在这里使用表并不是最佳解决方案,可能只是暂时的解决方法。 使用便捷工具 假设你成功地跟踪了所有内容创建任务,并使用清单快速获取必要的任务细节。太棒了!现在,是时候提交内容了。我建议使用技术写作软件来完成所有任务,即使它们与你正在从事的整体项目无关。这样做有多种好处,比如: 所有文件都存放在同一位置 最终输出可以使用任何流行格式 可以使用审阅工作流程和其他团队协作功能 技术写作软件可完美应用于任何类型的写作,并具备强大的文本编辑器、版本历史记录和拼写检查等功能。 当然,当我们谈论仅有一页长的营销文本时,使用技术写作工具可能有点过分。但是没有任何其他实质性的任务能够离开创建内容的工具。文档软件有助于不同部门组织内容创建过程。 结论 不要让任务堆积如山,把工作时间搞得一团糟!在以上建议的帮助下,你将能够安排好从不同部门得到的工作任务。利用专业工具和服务使你的工作流程保持一致。 祝技术写作好运! ClickHelp团队 跨平台和设备编写、托管和交付文档

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文