Latest Tips on Using Video Content in Technical Documentation

关于在技术文档中使用视频内容的最新小贴士

2021-01-27 17:50 clickhelp

本文共1618个字,阅读需17分钟

阅读模式 切换至中文

Do you often watch How-to videos on YouTube? I am sure you do it from time to time. As for technical communication, video has already become widely spread in user manuals. Statistics show that up to 75% of users do watch video content while almost everyone neglects text. When Should I Use Video Content? First of all, you should remember that video content cannot completely replace text and images, though it can add value and make the information easy to understand. Video content is the right solution to demonstrate the following: Movement. This can be any type of movement - how you move your mouse when you use a software product or how parts of a mechanism rotate. Sound. Some sounds are highly specific. There is no need to say that hearing a sound is much more informative than reading its description. State. How to describe the texture of a material or how to say that a pharmaceutical ingredient is not liquid enough? Simply add a video. Force. This is another thing difficult to describe. How hard to press a button or how hard to tighten up a screw? A picture won't show that. Apart from demonstrating something, using video content presupposes pursuing a goal: Reach out to as many users as possible. Even simple instructions on YouTube sometimes are watched by millions of users. Texts can hardly become that popular. Make learning more effective. Video content, as a rule, is more engaging than text. It is easier to perceive and remember information in this format. Make instructions unambiguous. Video content really helps to make the information clear and understandable. You can explain and demonstrate almost all specific things or moments. Save on translation and localization costs. Some videos are understandable even without voice or text comments. So, the same video content is suitable for users from different countries. If you manage to create a video like that, you’ll save a lot of money. Each purpose needs a specific type of video. The following post will give you more information about types of video content - Types of Video Content in Technical Documentation. When to Avoid Using Video Content? Though video content is highly informative, it is not always possible to implement this type of content, as I have already mentioned. Here is why: It is illegal. You’ve got to check if the use of video content is not prohibited by the law. For example, if you trade a product internationally, your documentation should be compliant with a number of legal requirements, standards, and rules. Besides, there are industries that, in general, are obliged to create technical documentation in accordance with legal requirements. Users do not have a stable Internet connection. If we talk about emergencies, it is all about finding the information right here and right now; and what if the Internet speed is low? In this case, it is better to have a backup option - to use a printed version of a user guide, for example. Content changes quickly. If your content is going to change very often, you will have to update the video oftentimes as well. Are you sure you are ready for that? Making a high-quality video is not a five-minute task. Actually, not all technical writers know how to do that. And, using a poor quality video will seem unprofessional. Lack of resources. Creating high-quality videos requires time, effort, and money. Either you hire someone to make a video, or you do it yourself, but you need to upgrade your skills and use suitable tools for that, which can be quite expensive. Popular Screencasting Software Screencasting is the process of recording your screen while using a software product. It is a good way of explaining things and documenting complicated tasks. It improves the learning experience. When video content is accompanied by text, it facilitates understanding. Moreover, short texts help users navigate and scan your video. One of the most popular types of video in software technical documentation is a screencast video. Screencasts can be used not only for tutorials but also for demonstrations and presentations. You can create dynamic and engaging content. Here are some screencast tools: Screencast-O-Matic. A widespread screencast tool. It has both a free and a premium version and is aimed at companies, developers, and students. Editing options will help you create a high-quality video that you can share via a link, YouTube, or Screen-O-Matic. Loom. This tool is great to quickly and easily record the screen. Both free and paid plans are available. Sharing is simple as well. The tool can be integrated into Gmail, Slack, Jira, etc. Bandicam. Is a powerful screen recording service. You can record live streams and skype calls. It is able to capture content for 24 hours straight. But it is only available on Windows XP and Vista 7, 8, 10. Camtasia. This screencast software is mainly for professional use. It is perfect for making professional tutorials and demo videos. In addition to that, Camtasia offers vast editing options. This tool has a paid plan only. Adobe Captivate. It is a highly comprehensive screencast software with a wide range of editing options. It is concentrated mostly on e-learning. The main advantage of this tool is its responsive video formatting. Screenium (MAC). A screencast tool for those who use MAC. It offers a lot of features. Video content can be published right on YouTube, Facebook, Vimeo, and Flickr. Or, you can send them via MAC message app or email. Icecream Screen Recorder. It can capture all types of videos: live streams, gaming, webinars. You can record the whole screen or just parts or it. It is also possible to add annotations and logos. Apowersoft. It is a really feature-rich tool that can help you create professional-looking videos, and it offers real-time editing. Available on Windows and MAC. How to Use Video When Creating Documentation in ClickHelp? First of all, I should say that using a video hosting platform is a great solution today. You can show your videos to millions of people, not worrying about the videos’ weight and how quickly they load. There is a great variety of video hosting services today: YouTube, Wistia, Vimeo, Brightcove, and many more! ClickHelp, being a modern online help authoring platform, supports modern technologies. It has built-in integration with the following video hosting platforms: YouTube Vimeo Screencast.com It means that ClickHelp allows you to insert interactive content, including video, into your technical documentation. It takes only a couple of minutes to upload a video on YouTube. But some people may be worried by the fact that their video may be available to all YouTube users, for example, as a related video, or someone will find it accidentally. Things like that may cause problems, especially if you want to add videos to password-protected documentation. Find more information on what password-protected documentation is in the following post - Should You Restrict Access to Your Online User Guides? YouTube has privacy settings for cases like that. Videos can be: Public - everyone can watch them Private - only users invited by you can watch them Unlisted - only those who have the link can watch them Unlisted videos do not appear in the search results, auto-suggested videos, and video tab - this is a great solution when you need to host a video on YouTube but don’t want to expose it too much. You can use other video hosting platforms as well and still insert those videos into your ClickHelp content. All of them enable you to generate so-called “embed code”. It is a piece of HTML that is used to embed a video to a web page. The same mechanism can be used in ClickHelp. You can generate embed code in your video hosting platform and use the Insert Custom HTML function in the visual editor to add a video to your topic. Another option is to upload your video file straight to your ClickHelp portal and add it to your topics. You just need to use the video tag from HTML5. As you know, ClickHelp is a multi-output technical writing tool. It means that you can both publish docs online and export them to PDF/DOCX. That’s when the following question appears - How to add a video in PDF? Right, your video will not work in a PDF document, and the document may even be printed, so having a video there does not make much sense. In ClickHelp, we have a solution that allows you to create a PDF version even when your documentation contains video. You can use conditional blocks to include or exclude parts of content in different outputs. For example, the online version will contain a video, and the PDF version will contain screenshots and a short video link in case users want to watch the video. It is even better to add a QR code - it will take a couple of seconds to find the video with a smartphone. That’s an elegant solution, isn't that? Conclusion To create smart technical documentation, you are to follow the latest trends. Video content is highly popular today; it can bring your docs to the next level. It means that technical writers must acquire new skills and learn new tools. It means as well that technical documentation tools must allow authors to add video content and readers to watch it. New reality presupposes detailed feature analyses to choose the tech writing environment that suits you best. Among so many alternatives, make the best choice for yourself! Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
你经常看YouTube上的教学视频吗?你肯定会时不时地看一些。至于技术交流,视频已经被广泛使用于用户手册中。 根据数据显示,高达75%的用户确实会观看视频内容,但是几乎所有人都会忽略文字信息。 我应该什么时候使用视频内容? 首先,您应该记住,虽然视频内容可以增加信息的价值并让信息更容易理解,但是它不能完全取代文本和图像。演示以下内容,选择视频内容是正确的: 移动。这可以是任何形式的移动--在你使用某款软件时,你该如何移动鼠标,或者一个机械装置的部件是如何旋转的。 声音。有些声音是很强的特异性。通过听声音当然比阅读它的描述能获得更多的信息量。 状态。如何描述一种材料的质地或如何说一种药物成分不够液态?只需添加一个视频。 力度。这是另一件难以描述的事情。按一个按钮要多用力,或者拧紧一个螺丝要用多少力?照片可无法说明这些。 除了做演示,使用视频内容的前提是追求一个目标: 让尽可能多的用户看到它。即使是YouTube上的简单指令,有时也会有数百万的用户观看。文本信息却很难传播得广泛。 提高学习效率。一般来说,视频内容比文字更吸引人。人们更容易感知和记忆这种形式的信息。 明确指示。视频内容确实有助于让信息变得更加清晰和易懂。你几乎可以解释和演示所有具体的事情或特定的时刻。 节省翻译和本地化成本。有些视频即使没有语音或文字评论也是可以理解的。所以,同样的视频内容适合来自不同国家的用户。如果你能制作一个那样的视频,你可以省下一大笔钱。 不同的用途需要用到不同类型的视频。下面的帖子将为你提供更多关于视频内容类型的信息-技术文档中的视频内容类型。 何时不应该使用视频内容? 尽管视频内容有很大的信息量,但正如我之前提到的那样,我们并不总是能够使用视频的形式。原因如下: 视频是违法的。你必须检查法律是否允许使用视频内容。例如,如果您进行产品的国际贸易,您的文件应该遵守许多法律规定,标准和规则。此外,一般有些行业有义务根据法律规定编写技术文件。 用户没有稳定的网络。如果是在紧急情况下,我们就需要在此时此地找到信息;然而网速慢怎么办?在这种情况下,最好有一个备份选项--例如,使用用户指南的打印版本。 内容更新速度快。如果你视频的内容经常改变,那么你就必须经常更新视频。你确定你准备好了吗?制作一个高质量的视频不是一项轻而易举的任务。实际上,并不是所有的技术作家都知道如何做只做高质量的视频。并且,使用低质量的视频会显得不专业。 缺乏资源。制作高质量的视频需要时间,精力和金钱。你无论是雇人制作视频,还是自己做,你都需要提升自己的技能,并且使用合适的工具。而那些工具还可能相当昂贵。 流行的录屏软件 录屏是指在使用某款软件给屏幕录像的过程。这是一种解释事情和记录复杂任务的好方法。它改善了学习体验。当视频内容配上文字时,它会更加便于理解。而且,简略的文字可以帮助用户导航和浏览你的视频。 软件技术文档中最流行的视频类型之一是录屏视频。 录屏不仅可以用于教程,还可以用于演示和展示。您可以创作动态的,引人入胜的内容。下面是一些录屏工具: Screencast-O-MATIC。这是一款被广泛使用的屏幕播放工具。它有免费版和付费版,用户面向公司,开发人员和学生。编辑选项将帮助您创建高质量的视频,并且您可以通过链接,YouTube或Screen-O-Matic分享视频。 Loom。这个工具有强大的快速简便地录屏的功能。它有免费和付费版本。分享视频也很简单。该工具可以在Gmail,Slack,Jira等软件中使用。 Bandicam。这是一个强大的屏幕录制服务。你可以录制直播和Skype通话。它能够连续24小时进行录制。但它只能在Windows XP和Vista7,8,10版本的电脑上使用。 Camtasia。这款录屏软件主要供专业人士使用。它非常适合制作专业教程和演示视频。除此之外,Camtasia还提供大量的编辑选项。此工具只有付费版本。 Adobe Captivate。它是一个功能非常齐全的屏幕播放软件,拥有广泛的编辑选项。它主要应用于电子化学习。该工具的主要优点是其响应性视频格式化。 Screenium (MAC)。为使用苹果电脑的用户提供的屏幕播放工具。它有很多功能。视频内容可以直接在YouTube,Facebook,Vimeo和Flickr上发布。或者,你可以通过MAC message app或电子邮件发送它们。 冰淇淋屏幕记录器(Icecream Screen Recorder)。它可以录制所有类型的视频:直播,游戏,网络研讨会。你可以录制整个屏幕或只是部分屏幕。你也可以添加注释和标识。 Apowersoft。这是一个功能丰富的工具,它可以帮助你制作专业的视频,并且提供实时编辑。在Windows和Mac的系统的电脑上都可以使用它。 在ClickHelp中创建文档时如何使用视频? 首先,我应该说如今使用视频发布平台是一个很棒的方案。你可以向数百万人展示你的视频,而不必担心视频的大小和上传速度。现在有各种各样的视频发布平台:YouTube,Wistia,Vimeo,Brightcove,以及其他更多! ClickHelp是一个现代的在线帮助创作平台,它支持现代技术。它嵌入了与以下视频发布平台: YouTube Vimeo ScreenCast.com 这意味着ClickHelp允许您将包括视频在内的交互式内容插入到您的技术文档中。 在YouTube上上传一段视频只需要几分钟。但有些人可能会担心他们的视频可能所有的YouTube用户都可以观看,比如说它作为一个关联视频,或者有人会意外地刷到它。诸如此类的事情可能会引起一些问题,特别是如果您想要将视频添加到加密保护的文档中。在下面的帖子中您可以查找到有关加密保护的文档的更多信息-是否应该对线上用户指南的观看设限?YouTube上有针对这种情况的隐私设置。视频可以是: 公共视频-每个人都可以看 私人视频-仅限您邀请的用户可以观看它们 未列出观看名单的视频-只有那些有链接的人才能观看 未列出观看名单的视频不会出现在搜索结果,自动建议视频和视频选项卡中--当你需要在YouTube上传一个视频,但又不想过度曝光它时,这是一个很棒的方法。 您也可以使用其他视频发布平台,并且仍然可以将这些视频插入到ClickHelp上的内容中。所有这些都使您能够生成所谓的“嵌入代码”。它是一段用于将视频嵌入到网页中的HTML。在ClickHelp中可以使用相同的机制。您可以在您的视频发布平台中生成嵌入代码,并使用可视化编辑器中的插入自定义HTML功能将视频添加到您的话题中。 另一种选择是直接将您的视频文件上传到您的ClickHelp门户网站上,并将其添加到您的话题中。您只需要使用HTML5中的视频标签标记它就可以了。 正如您所知,ClickHelp是一种多输出技术编写工具。这意味着您既可以在线发布文档,也可以将它们导出到PDF/DOCX。这时就出现了以下的问题--如何添加PDF格式的视频?没错,你PDF格式的视频是无法播放的,甚至文档可能被打印出来,所以PDF格式的视频是没有意义的。在ClickHelp中,我们提供了一个解决方案,即使您的文档包含视频,也可以采用PDF格式。您可以使用条件块来涵盖或排除在不同输出中的部分内容。例如,网络版的文档可能有一个视频,那么PDF格式的文档将包含视频截图和一个简短的视频链接,以防用户想观看这个视频。如果能再加上一个二维码就更好了--用户需要几秒钟来用智能手机寻找视频。你不认为二维码是一个更优的方法吗? 结束语 创建智能的技术文档,您必须紧跟最新的趋势。视频内容如今非常的流行;它可以将您的文档提升一个层次。这意味着技术类作者必须获得新的技能和学习新的工具。这也意味着技术文档工具必须允许作者添加视频内容,以及让用户观看。现在革新的技术让详细的特性分析成为了创作的前提,让你可以选择最适合自己的科技类写作环境。在这么多的选择中,做出最适合自己的决定吧! 祝你写出好的技术写作文档! ClickHelp小组 跨平台和设备的写作,上传和交付文档

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

阅读原文