Guidance Needed: Creating a Product Documentation Portal

Subject: Guidance Needed: Creating a Product Documentation Portal
From: GALA BRITT <gbritt -at- bellsouth -dot- net>
To: "techwr-l -at- lists -dot- techwr-l -dot- com" <techwr-l -at- lists -dot- techwr-l -dot- com>
Date: Fri, 31 Aug 2018 16:13:59 +0000 (UTC)

Hi All
I have been tasked with creating a secure, centralized portal for my organizationâs product documentation. This site is primarily for our customers, but employees may also need to login to access product documentation.ÂÂ
The people I have polled identified Mulesoft (https://docs.mulesoft.com/), ServiceNow (https://docs.servicenow.com/), SalesForce (https://help.salesforce.com), MapR (https://maprdocs.mapr.com/home/), and DataStax (http://docs.datastax.com) as sites that they like.
I have the usual requirements (users must log in, responsive layouts, ability to search content, ability to either generate a PDF on the fly or print/download a PDF, etc.). Currently about 80% of our documentation is in unstructured FrameMaker, 10% in RoboHelp, and 10% in Word.Â
One of my development teams would like to see everything moved to Markdown and stored in GitHub. Earlier this year I converted a FrameMaker document that used conditional text to Markdown and it was extremely time consuming. In addition, I had to rely on developers to create pre and post processing scripts to mimic the show/hide conditional text settings in FrameMaker and my work was stalled by the pull request process that we have in place.ÂÂÂI am a lone writer supporting multiple solutions that run on various platforms; I don't see Markdown as a viable solution for all of our documentation.Â
I have looked at numerous solutions and all seem to have their pros and cons. Is there a solution that would be best for a lone writer who will be solely responsible for implementing and maintain the portal? I have the budget to hire a consultant to get the project rolling and provide training, but otherwise I will be on my own.
Does anyone have any experience with selecting a solution? Thoughts to share regarding lessons learned when embarking on such a project? Is there a perfect solution out there or do I just need to pick the solution that best matches my requirements and find workarounds to achieve my desired results?
I'm on digest so it will take me a while to respond to any questions.

Thank you in advance for your guidance,Â
Britt
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | http://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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
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


Previous by Author: RE: Turn OFF smart text selection in PDF
Next by Author: Re: Are there segmented hypergraphics any more?
Previous by Thread: Re: Turn OFF smart text selection in PDF


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

Sponsored Ads


Sponsored Ads