Re: Web applications - docs for

Subject: Re: Web applications - docs for
From: Robert Lauriston <robert -at- lauriston -dot- com>
To: TECHWR-L Writing <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Tue, 23 Feb 2016 10:45:39 -0800

Whether a product is installed software or a web application or some
combination of the two is typically irrelevant to the cost-benefits
analysis of choosing the best authoring tool.

It sounds like you're talking about a single product, so major
questions you should consider are:

Are the developers using a framework that include an online help /
user assistance component, or will you need to write context-sensitive
help calls from scratch?

Will you need to support multiple versions of the product in use at
the same time (i.e., customers upgrade on their own schedule), or only
the latest version (i.e. your company upgrades all customers at once)?

Is the application usable on smartphones, or as a practical matter
does it require a larger screen or a keyboard?

Will you need to support translation or will it be English only?

How many writers and how many SMEs?

On Tue, Feb 23, 2016 at 7:44 AM, Damien Braniff <damien -dot- braniff -at- asg -dot- com> wrote:
> Looking at a new generation where the product will be entirely web-based and wondered what's the current perceived wisdom for documenting Web applications. Initial suggestions is HTML5 along the lines of Office 365 help and wondered what others are doing.
> Non web product go along the 'traditional' route at the moment - PDF + context help.
Visit TechWhirl for the latest on content technology, content strategy and content development |


You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com

Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at

Looking for the archived Techwr-l email discussions? Search our public email archives @

Web applications - docs for: From: Damien Braniff

Previous by Author: Re: least awful approach for keeping training slides up to date with core doc updates
Next by Author: Re: Requirements tracing with Word and Excel?
Previous by Thread: Re: Web applications - docs for
Next by Thread: Requirements tracing with Word and Excel?

What this post helpful? Share it with friends and colleagues:

Sponsored Ads