Technical writers can enhance the look and feel of their HTML5 user guides with the help of CSS. Most authoring tools come with built-in tools to quickly modify the settings. However, knowing how to tweak the CSS properties and values can prove beneficial and add more flexibility to the project.
CSS selectors help you select and style HTML elements. There are multiple types of CSS selectors, with each having its own set of rules. As a technical writer, the type of selector you use will depend on your requirements.
As a technical writer, you might have to include a considerable number of images in your documentation. Here are 6 tips and tricks I learned over the years that might prove helpful for a technical writer in performing image-specific tasks.
CSS allows technical writers to style their HTML5 help. Understanding CSS gives you more control over your project and considerably reduces dependence on web developers. Here, I list three ways technical writers can incorporate CSS into projects.
Technical writers can easily host their work or writing samples on GitHub by following a few simple steps. There is no cost involved, and it allows you to build your familiarity with this well-established and widely-used platform.
Technical writers can use HTML forms in their online help systems to collect data from readers through surveys or quizzes. Users can add input fields and a button to this form. When you add different HTML elements to the documentation, you are making the document more reader-friendly.
A technical writer can use tables to present information in a structured manner. It simplifies information and breaks the monotony by dividing content into easily readable chunks. Tables are undoubtedly more interesting than continuous paragraphs.
The HTML boilerplate in authoring tools contains the basic tags needed to run a webpage, such as the "html," "head," and "body" tags. But how do we insert ordered and unordered lists, images, and links? These are additional elements that technical writers frequently use in their HTML documents.
Although not mandatory, it is recommended that technical writers who use authoring tools like MadCap Flare acquire an elementary-level knowledge of HTML. It provides additional control to authors responsible for developing online help systems.
I recently experimented with implementing and customizing a scroll-to-top (or back-to-top) button on my HTML5 MadCap Flare Help. This button helps users scroll to the top of the page. It is a beneficial feature to have in HTML5 guides with long and comprehensive pages.
Technical writers should strive to make their product documentation as user-friendly as possible. Punctuation marks have the power to make or break a document. If used correctly, punctuation marks can convey more than intended. Avoid these common mistakes.
A common question in technical writing forums is whether to take up a course. The Google Technical Writing Course can help kickstart your technical writing journey entirely for free.