How to help people avoid reading

Web design principles for technical writers

Text by Sara Stein

Inhaltsübersicht

Image: © hitmanphoto/istockphoto.com

Since documentation moved from PDF to HTML, web design – the layout and user experience (UX) of websites – has become a relevant aspect of technical communication. Which web design principles should be implemented in documentation sites? Should they be treated the same as websites offering products or services?

To answer that, we need to consider the function of a documentation site. “Form follows function” is the famous axiom of industrial architect Louis Sullivan, who believed that the shape of a building or object should be derived from its intended purpose or function. By understanding the function of a documentation site, we can design it accordingly.

 

What’s the main function of a documentation site?

Online documentation can range from simple online help to a one-stop-shop for all your customers’ knowledge needs, a platform on which you showcase your industry expertise, help ...