为 SaaS 打造完美的技术作家测试和评估
已发表: 2023-04-24技术写作是销售和技术世界的桥梁。 它以一种同时满足决策者和日常用户的方式简化了复杂的概念。
那么,您应该聘请经验丰富的作家还是让开发人员自己编写技术文档? 答案应该都不是。 你需要一个伟大的技术作家。
Saas 为什么要聘请技术作家?
资料来源:Pexels
写作技巧不一定能转化为良好的技术写作。 对于自己开发应用程序的开发人员来说也是如此。
伟大的技术作家不一定是编码方面的专家。 他们只需要知道足够多的知识来展示软件的来龙去脉以及它如何使最终用户受益。 这样做提供:
改善销售体验
技术作家负责最终用户和决策者。 您的技术作家帮助销售人员创建易于理解的内容。 而且,当最终用户获得软件时,他们也会获得改进的产品体验。
改善产品体验
伟大软件的标志是它对新用户的直观性。 这些指南和教育内容可以帮助用户制定他们可以使用您的产品解决特定痛点的方法。 这最终会导致意识的提高。
提高技术意识
技术发展很快。 如果您在 SaaS 行业,生存意味着跟上最新趋势。 另一方面,繁荣意味着保持领先地位。
技术作家可以提供有关最新技术的文档,帮助开发人员进行产品更新,并帮助向目标受众宣传有价值的内容。
如何评估技术作家的技能
有几种方法可以测试技术作家是否符合您的标准。 以下是评估技术作家技能的五种最流行的方法:
技术写作能力
技术写作涵盖了广泛的专业知识。 您需要一位在以下方面表现出知识和技能的作家:
- 沟通。
- 研究。
- 与销售和技术开发团队合作。
- 灵活的写作风格,以迎合不同的受众群体。
- 在 HTML、CSS 或 API 文档等领域有足够的知识。
简化复杂概念的能力
如前所述,技术作家需要同时满足最终用户和决策者的需求。 技术作家通过将复杂的概念简化为引人入胜且易于理解的部分来实现这一点。
使用新产品或服务的想法在获得批准之前可能需要爬上几个阶梯。 在大多数情况下,它需要通过不懂技术的个人来运行。
熟悉文档开发生命周期
熟悉 DDLC(文档开发生命周期)的技术作家可以提高内容的质量、准确性以及将内容交付给受众的速度。
它遵循以下阶段:
- 分析与策略制定
- 设计
- 内容开发和文档审查。
- 出版
- 文档更新
观众分析
伟大的技术作家可以根据目标受众改变他们的写作风格。 在某些情况下,强调技术方面的更正式的写作效果最好。
其他人需要更随意的方法。 关键是了解何时何地使用这些写作风格以获得最大价值。
行业专长
技术作家需要足够的知识来理解 SaaS 产品或服务的齿轮和齿轮。 您可以通过各种测试评估候选人的知识,例如:
- 产品知识: CRM、Shopify、WooCommerce
- 特定于角色的知识: WordPress 开发人员、全栈开发人员。
- 编码知识:入门级 JavaScript、CSS 或 HTML:调试。
如何组织技术作家测试
资料来源:不飞溅
技术作家评估测试的结构取决于贵公司的需求。 但是,它通常涉及以下内容:
语言
语言测试应包括基本语法和语言问题或情境示例。 你可以问这样的问题:
- “登录”和“登录”有什么区别?
- 设置与“设置”有何不同?
- 什么时候用连字符连接某些词,比如 addon vs add-on?
- 句子结构最佳实践。
- 被动语态与主动语态。
API文档
该测试涵盖技术写作的技术方面。 在这里,您可以提出以下问题:
- 什么是 API?
- 诸如“什么是 Github?”之类的平台问题。
- 与编码相关的问题。
- 什么是开源文档?
- 合并提交与 Git 中的变基。
行业意识
测试的这一部分是关于技术作家对他们所在行业的来龙去脉的了解程度。他们应该期待这样的问题:
- 与当前行业趋势相关的问题。
- 行业术语/技术术语。
- 什么是冲刺回顾?
- 技术英语写作题。
- 什么是 UML 图?
简化和自动化招聘流程
为您的 SaaS 业务寻找完美的技术作家需要时间。 幸运的是,您不必煞费苦心地手动操作。 您可以自动化招聘流程的各个方面,例如:
职位描述自动化
如果您使用的是技术写作测试平台,您通常会发现数百个模板可供个性化使用。 您不必花费太多时间来起草职位描述。 在模板的帮助下,只需几分钟即可将副本与您要查找的内容对齐。
写作评估自动化
在提交职位描述和申请表后,下一步是评估申请人的技术写作能力。 您可以使用预先编写的模板来帮助自动化该过程。
这些模板可以包括内容简介、参考文档、示例、工作范围以及如何评估申请人输出的简要说明。
电子邮件跟进自动化
无论您的申请人通过或未通过初步评估,他们都可以通过电子邮件跟进自动化立即收到申请状态更新。
通过针对这两种情况预先编写的电子邮件,您可以轻松地通知候选人并帮助他们进入流程的下一步。 发送即时更新促进了一个高效的工作环境,作家们会欣喜若狂地加入。
关键要点
技术作家对任何企业都是必不可少的。 他们可以弥合销售与技术之间的差距,帮助改善用户体验、产品体验和技术意识。 因此,如果您想聘请技术作家,请考虑以下事项:
- 您如何评估他们的技术写作能力?
- 您将如何自动化和简化招聘流程。
- 你想问申请人的问题。
- 申请人在该行业的专业知识。
- 以及他们简化复杂概念的能力。