Where Should I Host a Technical Writing Portfolio?

我应该将技术写作文章存储在哪里?

2020-09-16 17:50 clickhelp

本文共661个字,阅读需7分钟

阅读模式 切换至中文

I recently wrote an article on how to compose a tech writing portfolio. The next logical step is actually making it available for future employers. Several things need to be considered: Ease of set up Ease of updating existing samples Can portfolio content be structured? Is it easy to share it? Let's study popular ways of storing tech writing portfolios and test them against these criteria we have chosen. Social Media The ‘light’ version of a portfolio storage. If you have a broad network of connections on your social media, you can try uploading some samples on your LinkedIn (here’s an instruction how to add samples on LinkedIn ) or Facebook page, for example. In case of Facebook and other social media that are less fitting for storing samples, you also can mention that you are willing to send out more materials to those interested. Ease of set up⭐⭐ Ease of updating existing samples⭐⭐ Can portfolio content be structured?⭐⭐ Is it easy to share it?⭐ Help Authoring Tools You might wonder how a help authoring tool can assist with a tech writing portfolio. Actually, it is a great way to store it online. In online technical writing tools like ClickHelp, all documents are stored in online documentation portals, and this is how you can keep your portfolio always updated and available for possible employers. Also, you don’t need to worry about formats since you can import existing samples to your portal or just use the tool itself to produce materials for the portfolio project. Ease of set up⭐⭐⭐ Ease of updating existing samples⭐⭐⭐ Can portfolio content be structured?⭐⭐⭐ Is it easy to share it?⭐⭐⭐ Personal Website If you already have a personal customized place where you advertise, this would be perfect for the job. Creating a personal brand works for technical writers pretty well. This approach might require more time, but the potential clients/employers will be impressed for sure. Luckily, you don’t need to actually build a website for hosting your portfolio from scratch. Instead, you can use WordPress or similar platforms to do that. Ease of set up⭐ Ease of updating existing samples⭐⭐ Can portfolio content be structured?⭐⭐ Is it easy to share it?⭐⭐⭐ GitHub GitHub is not a portfolio-oriented platform. This is actually a platform providing hosting for software development and version control. But, you can definitely set up a GitHub account and keep your sample technical documents there. A lot of software development companies are present on GitHub, so if you are aiming at creating software documentation and IT as a potential field of employment, this would be a great way not only to showcase your work, but also to emphasize that you know how GitHub works. Ease of set up⭐ Ease of updating existing samples⭐⭐ Can portfolio content be structured?⭐⭐ Is it easy to share it?⭐⭐ Offline There's nothing wrong with having an offline backup of your portfolio. However, nowadays it is better to use it merely as data backup. Simply because online portfolios are so much more convenient to create and to share! The times when we printed things out or sent them via email are long gone. Conclusion Where do you store your tech writing portfolio? A short answer is - online. As for a longer answer, I hope you received it after reading this post. The thing about a technical writing portfolio is that it has certain specifics. You would need a place where you can quickly organize your content that often is rather diverse format-wise, and also be able to update and share it effortlessly. As you can see from the ratings I gave above, hosting a technical writing portfolio by the means of a help authoring tool looks like the best option since HATs are created with the idea of storing technical documentation and swiftly updating it in mind. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
我最近写了一篇关于如何撰写技术写作文章的推文。实际上,下一个合乎逻辑的步骤是将其提供给将来的雇主。 需要考虑以下几点: 易于设置 易于更新现有版本 投资组合内容可以结构化吗? 易于分享吗? 我们来研究一下存储技术写作文章的流行方法,并根据我们选择的这些标准对其进行测试。 社交媒体 组合存储的“轻型”版本。如果您在社交媒体上人脉广泛,则可以尝试在LinkedIn(例如,这里有关于如何在LinkedIn上添加样本的说明)或Facebook页面上传一些样本。如果Facebook和其他社交媒体不太适合储存样品,您还可以提及自己愿意向感兴趣的人发送更多材料。 易于设置⭐⭐ 易于更新现有版本⭐⭐ 投资组合内容可以结构化吗?⭐·⭐ 易于分享吗?⭐ 帮助创作工具 您可能想知道帮助创作工具如何协助撰写技术写作文章。实际上,这是一种在线存储的好方法。 在诸如ClickHelp之类的在线技术写作工具中,所有文档都存储在在线文档门户中,这样一来您就可以随时更新文章,为潜在的雇主提供方便。另外,您无需担心格式问题,因为您可以将现有样本导入门户网站,或者只使用工具本身为文章生成材料。 易于设置⭐⭐⭐ 易于更新现有样本⭐⭐⭐ 投资组合内容可以结构化吗?⭐·⭐·⭐ 易于分享吗?⭐·⭐·⭐ 个人网站 如果您已经有可以个人定制的地方做广告,这将是理想的选择。创建个人品牌非常适合技术作家。这种方法可能需要更多时间,但潜在的客户/雇主肯定会对此印象深刻。幸运的是,您不需要从零开始建立一个网站来存储文章。相反,可以使用WordPress或类似的平台执行此操作。 易于设置⭐ 易于更新现有样本⭐⭐ 投资组合内容可以结构化吗?⭐·⭐ 易于分享吗?⭐·⭐·⭐ GitHub GitHub不是面向线上作品的平台。实际上,这是一个为软件开发和版本控制提供储存的平台。但是,您绝对可以设置一个GitHub帐户,并将样本技术文档保存在此处。GitHub上有很多软件开发公司,因此,如果您打算创建软件文档和把IT作为潜在的就业领域,这不仅是可以展示您的工作的最佳方式,而且可以强调您了解GitHub是如何工作的。 易于设置⭐ 易于更新现有样本⭐⭐ 投资组合内容可以结构化吗?⭐·⭐ 易于分享吗?⭐·⭐ 离线 对文章进行离线备份是好的。但是,如今最好仅将其用作数据备份。仅仅是因为线上作品更易于创建和共享! 我们打印东西或通过电子邮件发送东西的时代早已一去不复返了。 结论 您将技术写作文章存储在哪里? 一个简洁回答是--在线。至于更长的答案,希望您阅读这篇文章后收到。技术写作文章的特点在于具有某些细节之处。您需要一个可以快速组织内容的地方,这些内容通常在格式上非常多样化,并且可以易于更新和共享。从我上面给出的评分中可以看出,通过帮助创作工具存储技术写作文章似乎是最好的选择,因为HATs的创建理念是存储技术文档并迅速进行更新。 祝愿技术写作之旅愉快! ClickHelp Team 跨平台和设备编写、托管和交付文档

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

阅读原文