在快速发展的技术交流领域，专业人员的任务是将复杂的信息转化为可理解和可操作的内容。为了阐明这个多方面的领域，我们有幸与一位经验丰富的技术交流专家GreyOrange的高级经理兼信息开发人员Mridula Menon进行了交谈。她已经与ClickHelp合作了很长时间，帮助各种公司解决复杂的文档任务，并取得了出色的成果。今天，我们将与她进行对话，深入探讨她的经历、见解和塑造她旅程的策略。在这次独家采访中，我们的专家坦率地展示了她从一名软件开发人员到一名熟练的技术作家的演变过程，反思了推动她追求这条独特职业道路的关键导师、经历和个人动机。Mridula强调了技术写作的动态本质，通过ClickHelp进行有效协作的力量，以及语言技巧和技术实力之间的复杂平衡。 教育背景 ClickHelp：你是从哪里学会成为一名技术作家的，是什么促使你走上这条职业道路的？你能分享一些影响你旅程的值得注意的经历或导师吗？ 姆里杜拉·梅农：虽然我是一个数学爱好者，但我一直对英语有着浓厚的兴趣，并且曾经是一个如饥似渴的读者，这加强了我的语言技能。我的第一次写作是以给母亲写信的形式，当时我在大学期间离开她生活了3年。然后，当我开始作为一名软件开发人员工作时，写作就具有了技术性，我必须自己编写开发文档。我在技术写作方面的第一位导师是Debbi Bock，她是我在甲骨文的第一位经理。 作为一名技术作家，你觉得哪些方面最有成就感？它如何与你的个人和职业目标保持一致？ M：老实说，我不喜欢被困在同一个领域。与软件开发人员不同，技术作者可以探索多个领域，了解它们，并撰写相关文章。与此同时，他们也成为客户宣传的冠军。每个组织都必须能够使用技术作者作为第一线用户，他们可以对产品的可用性给出诚实的反馈。TW可以发现产品的任何更直观的方面，并在文档中进行解释。 许多组织削弱技术作家，我的职业目标是消除对作家的偏见。 我个人的目标是成为作家的代言人，并确保TW社区在技术世界中受到尊重。 工作经验和项目 你能提供一些你职业生涯中参与过的不同项目的细节吗？这些项目属于哪些行业，你在每个行业都遇到了哪些独特的挑战？ M：嗯，我从事过C++项目，在技术支持团队中为戴尔笔记本电脑和台式机排除故障，作为开发人员用Seibel脚本编写代码，作为业务分析师掌握Oracle BI，从事Oracle HCM API文档，从事Oracle OCI文档，学习并获得Salesforce健康保险应用程序，现在我第一次担任由团队处理软件和硬件文档的角色。我在GreyOrange的仓库自动化世界里。 让我告诉你，如果有人想找一份没有任何挑战的工作，他们是不会找到的。每个角色都有挑战。然而，不变的是我解决这些问题的策略。对于一个TW来说，任何职位最大的挑战就是知识；它并不总是容易或容易获得的。这是作家需要处理人际关系的地方。通过建立信任关系，我们可以磨练我们对产品的了解，因为我们往往会变得足智多谋。 你能描述一下你处理过的一个特别复杂或具有挑战性的技术写作项目吗？你是如何处理的，你采用了什么策略来克服你遇到的困难？ M：我在GreyOrange才几周大，我被要求帮助实施DAP。在那之前，我甚至不知道DAP代表数字采用平台。我是该组织的新成员，刚刚开始了解自动化行业和仓储。我会在晚上学习DAP，早上从事实现工作。我的日子又长又累，但非常令人满意，因为每天我都在运用我所获得的每一点知识。产品团队非常支持我，帮助我理解了必须为最终用户简化的流程的复杂性。同样，尽管处于内容主管/高级经理的位置，我仍然是一个谦逊的学生，这帮助我与产品团队建立了持久的关系。作家的强项在于他们能够如何顺利地获取知识，简化知识，并将其呈现给最终用户。文档领导者的强项在于他们如何展示文档团队在最少指导下处理复杂知识的强项。 科技写作工具的选择与运用 采用一个新工具通常伴随着一个学习曲线。根据你的经验，熟练使用一种新的技术写作工具通常需要多长时间？你能分享一下你用来加快学习过程的策略或资源吗？ M：所有工具的学习曲线都不一样。对于基于DITA的XML编辑器（如Oxygen）来说，这一比例较高，而对于类似Wiki的工具（如Confluence或HelpDocs）来说，这一比例非常低。点击帮助在中间的某个地方。ClickHelp功能丰富；因此，理解每个特性并弄清楚如何利用它们需要时间。策略之一是一个人教另一个人。因此，整个团队的任务是掌握工具的一个方面，并将其传授给其他人。这应该是每天的活动。一旦探索了所有特性，所有团队成员都需要创建一个演示文档，并让彼此审阅。作为高级经理，我解决所有的技术问题或障碍。我研究全面的ClickHelp文档，如果我需要帮助来解决一个案例，我会联系出色的ClickHelp支持。我很高兴地说，通过你们勤奋的支持团队，我总能找到我的问题的答案！ CH：在选择技术写作工具时，你通常会考虑什么标准？你能举例说明你是如何评估不同选项的，是什么让你选择了ClickHelp吗？ M：就像选择合作伙伴一样，我们不可能在一个工具中拥有所有的品质。所以，我首先列出了17种不同工具的优缺点。我的下一步不是关注优点，而是关注缺点。如果我在一个不可协商的领域发现了一个骗局，例如，如果评论不可用，我会拒绝这个工具。在经历了整整一个月的演示和试用版后，我锁定了3个首选，其中之一是ClickHelp。我开始研究用户对产品支持质量和稳定性的评论。ClickHelp是我唯一可以看到他们客户的文档门户的工具，这非常有说服力。与他们的销售工程和客户支持团队互动是一种乐趣。我只是想让你知道，我和我的整个团队都喜欢这个产品。 除了ClickHelp，你还有其他日常使用的软件工具或平台吗？作为一名技术作家，这些工具如何增强你的工作流程或帮助你实现目标？ M：是的，当然，我们的发行说明以使用Gdocs生成的pdf格式发布。我们的内部交流发生在合流和吉拉。Gdocs极大地帮助了我们与利益相关者的合作，主要是QA经理和产品经理。合流是发电站；我们在Confluence中记录了所有的sop和会议记录。这是我团队的知识库。 ClickHelp如何使创建文档变得更容易 CH：是什么因素影响了你选择ClickHelp作为首选技术写作工具的决定？有没有什么特别有价值的特性或功能让你觉得特别有价值？ M：有很多：工作流、条件内容、控制出版物、访问HTML和CSS文件、托管服务器、可重用性以及图像和媒体文件的轻松存储，等等。我对售后支持非常挑剔，我想说你们的客户在这方面的评价非常高。 CH：在你看来，ClickHelp的主要特性是什么，使它成为技术作者的一个有价值的工具？你能分享一下这些功能对你的工作产生重大影响或提高效率的具体例子吗？ M：发布文档和维护版本的便利性真的有很大的不同。内容可重用性确保公共内容不会在多个主题中重复。在文档发布之前预览发布的版本对作者来说也是一件幸事。 ClickHelp抽象了文档工具的复杂性，使作者能够专注于他们的写作。 CH：协作在技术写作项目中至关重要。你能举例说明在你以前的项目中，ClickHelp是如何改善团队成员之间的协作的吗？ClickHelp中的哪些特性或功能促进了有效的协作？ M：我的作者经常在同一个项目中处理不同的文档，而不会互相冒犯。只有当他们解锁时，我才能编辑他们正在处理的文档。这意味着我需要他们的知识来撤销他们的任何更改。不仅如此，我们选择的工作流有三种状态——草稿、正在审查和就绪。这使得为同行评审分配文档变得容易。 如你所见，在团队内部，我们可以无缝协作。现在，让我们看看我们如何与利益相关者合作；我们可以为涉众分配一个审阅者角色，这样他们就可以向我们创建的文档添加注释，而不会有意外删除我们内容的风险。然后，我的作者可以合并评论，并将文档推向生产。 CH：考虑到技术文档的最终用户或消费者，ClickHelp在用户体验方面有什么优势？它如何有助于增强文档的可读性、可访问性或可用性？ 男：嗯，有不少；首先，在GreyOrange，我们的文件是不公开的。它们严格来说是为内部观众和我们的客户准备的。因此，我们实施了SSO，这意味着我们的最终用户可以通过安全的渠道访问我们的内容。除此之外，我们还可以发布一个没有菜单的独立静态页面，以防我们需要共享一个需要打印或查看的独立文档。当我们需要在防火墙之外共享一个特定的文档时，这很有用。 但ClickHelp最有趣的方面是，我们可以通过我们的应用程序访问我们的客户，这样他们就不需要输入任何SSO信息，只需获得访问相关文档的通行证。 我们还可以为不同的用户创建不同的出版物；条件格式确保正确的受众可以查看正确的内容，最后但同样重要的是，受谷歌启发的奇妙搜索功能。 保持消息灵通，为有抱负的技术作家提供建议 CH：作为一名技术作家，了解最新的行业新闻和趋势是很重要的。你个人是如何让自己了解并跟上该领域的最新发展的？ M：我相信神，并且有幸有合适的机会不仅作为观众参加会议，还在相当多的会议上在线和离线发言，以及为一些会议做志愿者。 根据你的经验和专业知识，你会给渴望成为技术作家的人什么建议？你认为在这个领域取得成功的关键技能、资源或策略是必不可少的吗？ M：凭借多年来在各种角色中的经验，我现在很清楚哪个角色需要什么技能。要成为一名优秀的作家，首先要有正确的态度，带着正确的心态走进这个领域。如果有人认为这是技术世界中最容易的角色之一，他们会大吃一惊。越来越多的科技写作倾向于科技和信息，而不是写作本身。现在，科技作家不仅需要以清晰而简单的方式解释产品或流程，还需要使用各种格式呈现信息，如音频、视频、AR、DAP、聊天机器人等等。所以，进入这个领域，准备好学习你遇到的任何东西，并在产品知识方面出类拔萃。你需要在产品知识方面的能力来简单地解释复杂的概念。 CH：作为一名技术作家，你能分享一些难忘的经历吗？这些经历突出了你的工作的影响或者你给项目带来的价值。 M：我是那种花很多个人时间自学的人。无论我学到什么，我都会试着在工作中使用。无论我在工作场所使用什么，我都会试着教我的团队。因此，作为一名IC，我试图在我的工作中带来创新，作为一名高级经理，我将我的知识传播给我的团队，以便他们能够成长。我让他们变懒了吗？不，我试着把一项技能教给一个人，让我的团队互相训练。通过这种方式，团队之间建立了良好的关系。 在我以前的一个组织中，我是一名首席技术作家，安排与高级产品经理的会面几乎是不可能的。我会一直醒到IST凌晨3点和他说话，录下电话，并以一种总是超出他预期的方式把文件交给他。但可悲的是，作家在公共平台上从未得到赏识。值得庆幸的是，在GreyOrange，我们因所做的出色工作而备受瞩目，因为我们得到了产品管理副总裁的大力支持和赞赏。作为一名经理，我觉得这就是我带来的不同。我帮助我的团队在更多的观众面前获得赞赏，这是我作为个人贡献者在旅程中错过的。 CH：你还有什么想补充或讨论的，可以展示你给技术写作领域带来的独特视角和见解，特别是关于你在项目中使用ClickHelp的？ M：我们GreyOrange经营的是高端产品，是硬件和软件的混合体。因此，我的主要关注点是消除使用文档工具的复杂性，让作者专注于获得正确的内容。l可以在ClickHelp中访问的所有数据和元数据都被充分利用，以确保文档的复杂性被抽象出来。例如，在过时的文档上运行报告帮助我确保l可以有效地进行CRUD练习，以确保只有最好的内容到达用户手中。我已经创建了相当多的自定义控件，我的团队可以在他们的文档中使用。这是我第一次在我使用的工具中使用这样的特性。我的下一个目标是自动化文档创建，以便其他团队可以使用ClickHelp来满足他们的文档需求。 我认为ClickHelp是一个可塑性很强的工具。我们可以随心所欲地使用它。因此，整个文档结构可以很容易地定制。能够在没有工程团队任何帮助的情况下以不同的方式迎合不同的客户，充分说明了以极其智能的方式使用ClickHelp是多么容易。 结论 我们绝对可以称Mridula Menon为经验丰富的技术交流专家，他可以成为该领域新人和老手的灵感灯塔。语言艺术和技术敏锐度的融合，加上她对学习的坚定不移的承诺，体现了一个成功的技术作家的本质。选择ClickHelp作为协作工具增强了她对无缝团队合作和高效知识传播的追求。Mridula倡导在技术世界中培养对技术作者的尊重和认可，这引起了共鸣，对技术交流的叙事产生了深远的影响。随着技术行业的进步，这位专家的见解证明了蓬勃发展的技术写作世界的弹性、创新和适应性。 祝你的技术写作好运！ 单击帮助团队 跨平台和设备创作、托管和交付文档