作者：Greg DeVore 2016年11月2日

教学与提醒

软件文档技巧|呼叫中心| Ed Tech

分享：

如果你正在为客户支持或内部培训建立知识库，那么记住你希望这篇文章完成什么是很重要的。

在一个完美的世界里，你可以写一篇文章，并将其用于培训、培训和支持。这是很多人采取的方法。但这是一个大错误。当某人需要接受培训时，他们的需求与她需要提醒时大不相同。

接受培训的人员需要理解概念、定义和工作流。只需要快速提醒的人只需要一个快速的分步指导。

培训文章的常见格式

培训文章通常从一些背景信息开始，包括逐步说明，解释一些概念，回到更多的步骤，然后介绍更多的概念。

这种格式可能适合初次使用；然而，对于那些已经理解了概念和背景信息的读者来说，这是非常乏味的，他们只是想知道要单击哪些按钮。

从培训文章中提取操作信息我们的建议是创建第二个（一组）帮助文章。你所需要做的就是从你的培训文章中提取简单的逐步解释，并创建参考文章。

如果培训文章中的分步说明都是相关的（例如“如何创建用户帐户”），那么您只需要创建一篇额外的参考文章。

但是，如果您的培训文章包含多个不同任务的分步说明（例如，“如何创建用户帐户”和“如何预算加班”），则为每个任务创建单独的参考文章。

这样，读者就可以查看如何完成他们需要帮助的确切任务，而不必费力阅读大量不适用于手头工作的信息。

越多越好（至少在本例中是这样）如果你试图为两种情况（培训和参考）创建一篇文章，那么你会让两位读者都感到沮丧。

当你在写一篇培训文章时，一定要解释：

为什么有些东西很重要什么定义意味着什么总体工作流程和业务目标是什么如果你只是想写一篇提醒文章，比如一份工作帮助或分步指南，那么只需要列出一个需要完成的步骤的清晰列表。

是的，你将得到两篇文章而不是一篇。但这两篇文章都会被更多人使用。

关于Greg DeVore

ScreenSteps

首席执行官与Greg DeVore联系