How to Manage Your Technical Writing Backlog

如何管理你的技术写作积压

2021-02-24 18:50 clickhelp

本文共1111个字,阅读需12分钟

阅读模式 切换至中文

If you are a technical writer, I am sure you’ve got an endless backlog. It is sad but so true to life: so many tasks are to be done, and so little time! Even professionals in the sphere of task and time management may suffer from a problem like that. So, let’s figure out how to cope with piling up tasks to increase your company’s productivity. Why Bother About Backlog? You might say that having a backlog is inevitable, and there is no need to cope with it right away - one can just let it go. But that’s a huge mistake! What can happen if a technical writer has an unmanageable backlog? - Depression =) But actually not only that… Unreasonably long tech writer’s backlog leads to: Financial losses. Some types of technical documentation indirectly affect a company’s financial performance - for example, docs aimed at customer or employee support. If instructions do not help customers solve their problems, some of them may give up using a product; others will reach out to the support team, increasing the number of tickets. If technical documentation doesn’t help employees maintain and fix a mechanism, a factory may suffer from disruption. Legal wrangling. Technical documentation aimed at safety issues is a top priority. If a company fails to provide users with these docs, they won’t be able to use a product safely; in case of injuries, legal actions may take place. Inability to achieve goals. Definitely, a company that fails to solve its problems and support its processes will not achieve its goals for the week, month, and year. Slow workflow. The longer your backlog is, the more time you need to manage it. But to manage tasks doesn’t mean to do them, unfortunately. Which Tasks Are Most Important? All the tasks we get are urgent, as a rule. But are they equally urgent? To tell the truth, they are not. The previous section shows that docs related to financial performance, safety, or legal issues have the highest priority. Yes, it is true. But what else deserves our attention? First of all, documentation aimed at supporting the weakest processes and points in a company. Each company has its own soft spots. It can be anything. These are the tasks to do first. If your company copes with these issues, it is going to be a great step forward. Updating the most popular documents. Sometimes, technical writers face the following problem: a new release is coming, piles of documents are to be updated, and you have only a couple of days to cope with all that. Is it familiar to you? The best idea is to choose the most popular documents that readers use every day and update them right away. As for the rest of the docs, you can do it step by step after release - it is ok. Choose the tasks that have been longest in your backlog. Analyze tasks from your backlog that have been there for a long time. They can be divided into three categories: Tasks that have already become irrelevant - if you have not done a task within a long period, it might be irrelevant, and no one needs it anymore. Let’s say the situation might have changed. Tasks that can wait a bit longer - these are important tasks, but you can do them in a week or two. Tasks that become even more significant - the longer a task like that waits, the more significant it is. It has the highest priority. How to Keep Your Backlog in Order? The first thing I recommend is to follow the strategy you’ve chosen. Stick to it every day, and you will see that your backlog is manageable. Of course, unscheduled things may take place, which is inevitable but being systematic will save your backlog from chaos. What else you are to do: Not all ideas should be added to your backlog as tasks. Before creating a task, make sure you and your team need it. Use components to categorize your tasks. The majority of project management tools allow users to select components for tasks to identify where they belong to: features, bugs, newsletters, onboarding documentation, FAQ, etc. You can create any component you need. They help to filter tasks when you need to check what should be done. Use due dates. When you have a due date, you can filter your tasks to see when and what should be done. No doubt, you should use a project management tool or a help authoring tool that offers task tracking. What Project Management Tools to Use? Project management tools are tools to organize workflow, track progress and goals, collaborate with team members, etc. They help not only to organize the workflow within a team but also to cooperate with other departments. We have a post about that - Tracking Technical Writing Tasks When Working with Other Departments. Project management tools can be both free and paid. They are good for team and individual work. Here is the list of the most widely used ones: LiquidPlanner. One of the most impressive project management tools. It helps to manage and track not only workflow but also resources and staff availability. Teamwork. An online platform to ease the pains of managing projects, milestones, and tasks. Zoho Projects. Software for project management for those who do not want to spend much. Celoxis. A tool that helps to track not only tasks but project budget as well. GanttPro. Shows how tasks in your project contribute to the end result. Proofhub. An online project management application to organize and track projects and collaborate. Redmine. An open-source tool for task tracking with plug-ins for adding specific features. ClickHelp, as an innovative solution for tech writers, offers task tracking features for users’ convenience. Our report center will give you a bird’s eye view of your or your team’s workflow. You will see the amount of content each author has written, what is to be done, how many topics are to be reviewed, and other data showing project’s readiness. Moreover, topic statuses and email notifications will not let you miss anything. Conclusion To successfully manage tech writer’s backlog, one needs to stick to the chosen strategy and, of course, use special tools. But not only that is important. A lot depends on a tech writer’s ability to self-organize, resist procrastination, and be disciplined. But that is another topic for discussion. Check out our post - Personality Characteristics of a Technical Writer. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
如果你是一个技术作家,我肯定你有一个无穷无尽的积压。这是悲哀的,但却是如此真实的生活:如此多的任务要做,而时间却如此之少!即使是任务和时间管理领域的专业人士也可能会遇到这样的问题。所以,让我们来弄清楚如何应对堆积如山的任务,以提高你公司的生产力。 为什么要担心积压呢? 你可能会说,有一个积压是不可避免的,没有必要马上处理它--一个人可以让它过去。但那是个巨大的错误!如果一个技术作家有一个无法管理的积压,会发生什么?-抑郁=)但实际上不仅如此… 不合理的长时间科技写作积压导致: 经济损失。某些类型的技术文档间接影响公司的财务绩效--例如,针对客户或员工支持的文档。如果说明书不能帮助客户解决他们的问题,他们中的一些人可能会放弃使用一种产品;还有人会向支持团队伸出手,增加了门票数量。如果技术文档不能帮助员工维护和修复一个机械装置,工厂可能会受到干扰。 法律上的争论。针对安全问题的技术文档是重中之重。如果公司不能向用户提供这些单据,用户将无法安全地使用产品;如果发生伤害,可能会采取法律行动。 无法实现目标。毫无疑问,一个公司如果不能解决其问题并支持其流程,将无法实现其周,月,年的目标。 工作流程缓慢。积压的时间越长,管理它所需要的时间就越多。但不幸的是,管理任务并不意味着去做它们。 哪些任务最重要? 我们接到的任务通常都很紧急。但它们同样紧迫吗?说实话,他们不是。上一节显示与财务业绩,安全或法律问题相关的文档具有最高优先级。是的,是真的。但还有什么值得我们关注的呢? 首先,文档旨在支持公司中最薄弱的过程和点。每家公司都有自己的软肋。可以是任何东西。这些是首先要做的工作。如果你的公司处理好了这些问题,这将是一个很大的进步。 更新最流行的文档。有时,技术作者会面临以下问题:一个新的发布即将到来,成堆的文档需要更新,而您只有几天的时间来处理所有这些。你熟悉吗?最好的想法是选择读者每天使用的最受欢迎的文档,并马上更新它们。至于其余的文档,你可以在发布后一步一步来做--这是可以的。 选择积压时间最长的任务。分析积压已久的任务。它们可分为三类: 已经变得无关紧要的任务--如果你在很长一段时间内没有完成一项任务,那么它可能是无关紧要的,而且没有人再需要它了。假设情况可能已经改变了。 可以再等一段时间的任务--这些都是重要的任务,但你可以在一两周内完成。 变得更加重要的任务--这样的任务等待的时间越长,意义就越大。它具有最高优先级。 如何使你的积压工作井然有序? 我建议的第一件事是遵循你选择的策略。每天坚持下去,你就会看到你的积压是可以管理的。当然,计划外的事情可能会发生,这是不可避免的,但系统化将使你的积压免于混乱。你还能做什么: 不是所有的想法都应该作为任务添加到你的积压中。在创建任务之前,请确保您和您的团队需要它。 使用组件对任务进行分类。大多数项目管理工具都允许用户为任务选择组件,以确定它们所属的位置:功能,错误,时事通讯,入职文档,FAQ等。您可以创建您需要的任何组件。当您需要检查应该做什么时,它们有助于筛选任务。 使用到期日。当你有一个到期日时,你可以筛选你的任务,看看什么时候应该做什么。 毫无疑问,您应该使用提供任务跟踪的项目管理工具或帮助创作工具。 使用什么项目管理工具? 项目管理工具是组织工作流,跟踪进度和目标,与团队成员协作等的工具,它们不仅有助于组织一个团队内的工作流,还有助于与其他部门合作。我们有一个关于那个的帖子--在与其他部门合作时跟踪技术写作任务。 项目管理工具既可以是免费的,也可以是付费的。它们对团队和个人工作都有好处。下面是使用最广泛的一个列表: 流动计划者。最令人印象深刻的项目管理工具之一。它不仅有助于管理和跟踪工作流程,还有助于管理和跟踪资源和工作人员的可用性。 团队合作。一个在线平台,减轻管理项目,里程碑和任务的痛苦。 Zoho项目。为那些不想花很多钱的人提供项目管理的软件。 塞洛克斯。这是一个工具,不仅可以帮助跟踪任务,还可以跟踪项目预算。 甘特普罗。显示项目中的任务对最终结果的贡献。 校对中心。一个在线项目管理应用程序,用于组织和跟踪项目并进行协作。 雷德明。一个用于任务跟踪的开源工具,带有用于添加特定功能的插件。 ClickHelp作为一个为科技作者提供的创新解决方案,为用户提供了任务跟踪功能。我们的报告中心将为您提供您或您的团队工作流程的鸟瞰。您将看到每个作者所写的内容的数量,要做什么,要审查多少主题,以及其他显示Project准备就绪的数据。而且,主题状态和电子邮件通知不会让你错过任何东西。 结论 要想成功管理科技作家的积压,需要坚持选择的策略,当然还要使用专门的工具。但不仅这一点很重要。这在很大程度上取决于科技作家的自我组织能力,抵制拖延和自律能力。但那是另一个讨论的话题。看看我们的技术作家的后人格特征。 祝你的技术写作好运! 单击帮助小组 跨平台和设备编写,托管和交付文档

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

阅读原文