• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
Facttactic

Facttactic

Corporate and technical writers

  • Home
  • PR writing
  • Web writing
  • Technical writing
  • Comms management
  • Blog
  • Contact
  • About

benefits of online user guides

June 29, 2020

If you’re writing a user guide or policy manual, or similar, and its target readership (staff or customers) is spread over different locations, I often recommend moving away from a printed document (such as Word/PDF).

Instead, I steer clients towards creating online (HTML or XML) documents.

That sounds like it’s introducing new complexities but, really, the learning curve is not steep, and the benefits strongly outweigh what is largely, and simply, concern of the unknown.

To help explain more about what an online user guide looks like, how it works and what its advantages are, I have built a simple prototype you can play with and that answers those questions.

You can find it here: http://technical-writer.co.nz/sample-online-manual/introduction.html

—–

Help authoring | Component authoring | Component content management | AuthorIt | Robehelp | MadCap Flare | HelpnDoc

Filed Under: Technical writing, Web Content Tagged With: AuthorIt, Component authoring, Component content management, Help authoring, Helpndoc, MadCap Flare, Robohelp

Reader Interactions

Leave a Reply Cancel reply

Your email address will not be published. Required fields are marked *

Primary Sidebar

Facttactic’s Blog

  • how to easily move a WordPress website to a new web host
  • the need for website speed
  • benefits of online user guides
  • new resource for Māori writers
  • great deal for e-commerce websites
  • the Auckland and all-over technical writer
  • not enough small businesses online!
  • technical-writer.co.nz
  • microsoft’s writing style guide is now free and online
  • wamp up your website
  • style guide for online content
  • blogging: keep it up or take it down



website by mighty atom

 

Loading Comments...