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.
Re: Has anyone combined their company's docs/downloads into a single page?
Subject:Re: Has anyone combined their company's docs/downloads into a single page? From:Emoto <emoto1 -at- gmail -dot- com> Date:Wed, 9 Nov 2016 11:12:44 -0500
I've done it too. Only a single web page to maintain! ;-)
I always offered a link to a zip file with the whole doc set, as well as
individual doc links. I liked to label the links with the date of the most
recent update.
Bob
On Wed, Nov 9, 2016 at 11:06 AM, Robert Lauriston <robert -at- lauriston -dot- com>
wrote:
> I've done it at a few places. It works fine so long as you don't have
> an unwieldy number of downloads.
>
> It's simpler for users to find what they need when the doc links are
> next to the download links. You can have something like:
>
> Product X <download installer> <Release Notes> <Installation Guide>
> <User Guide> <Admin Guide>
>
> Product X Developer's Kit <download installer> <Release Notes>
> <Programmer's Guide> (API reference is included with installer)
>
> ...
>
> On Wed, Nov 9, 2016 at 6:05 AM, Kelly <kparr888 -at- gmail -dot- com> wrote:
> > The marketing director where I work wants to put documentation (HTML
> only) and product downloads on a single page.
> > Our downloads page is fairly detailed and divides links to resources by:
> > - Binary downloads
> > - Open source downloads
> > - Packages
> > It also points to the documentation landing page, which contains links
> to docs for 3 in-market releases.
> > This setup is simple, easy to find, and no users have complained.
> > Also, this division of resources (docs/downloads) is what I've
> experienced in > 15 years of tech writing.
> > Given I have no experience with the pros and cons, I I feel at a
> disadvantage and want to make an informed decision in case I need to push
> back at Marketing. I was unable to find examples online of companies that
> combine the two.
> >
> > I'm hoping this group has opinions on combining docs/downloads into one
> page.
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | http://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as emoto1 -at- gmail -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
>http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com