TechWhirl (TECHWR-L) is a resource for technical writing and technical communications professionals of all experience levels and in all industries to share their experiences and acquire information.
For two decades, technical communicators have turned to TechWhirl to ask and answer questions about the always-changing world of technical communications, such as tools, skills, career paths, methodologies, and emerging industries. The TechWhirl Archives and magazine, created for, by and about technical writers, offer a wealth of knowledge to everyone with an interest in any aspect of technical communications.
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 | http://techwhirl.com
