Splitting up large help set into multiple sets
Posted: Fri Apr 04, 2025 2:59 pm
(Generally speaking, this is yet another project organization question.)
I've been told that "we have too much documentation" and that searching it "gives you too many results that aren't relevant" and that I need to figure out a way to solve this problem.
Currently everything is in a single Flare project that gets output to HTML. I can see the point of the criticism. I have proposed breaking it down into individual libraries that will be structured according to user roles/task. There will be a main landing page to the help site where users can then access the specialized documentation libraries. Some of you out there have similar setups, at least according to the discussions that I've scanned in this forum. So, nothing really groundbreaking about that.
After looking into Global Project Linking, I think my best bet is to still have everything in a single Flare project and just have individual HTML targets for each content set. Plus, when the inevitable philosophical reversal comes a few years down the road, that will make things easier.
I'm working up a POC at the moment. As of now my two main questions are:
#1 - Output Structure
Right now the help is deployed in an Amazon S3 bucket. I believe it is configured to launch /Content/Home.htm by default. So, I'm thinking this means that the Portal Home still has to be in the root, and the output of the other modules have to be in a subfolder of that output. What is the best way to structure that?
#2 Linking
How do I need to format cross library links so that they will work? The obvious way seems that they need to be relative hard coded links to where I know the output will live on the server. Is there any way to make that automatic?
Thanks in advance for any thoughts and advice.
I've been told that "we have too much documentation" and that searching it "gives you too many results that aren't relevant" and that I need to figure out a way to solve this problem.
Currently everything is in a single Flare project that gets output to HTML. I can see the point of the criticism. I have proposed breaking it down into individual libraries that will be structured according to user roles/task. There will be a main landing page to the help site where users can then access the specialized documentation libraries. Some of you out there have similar setups, at least according to the discussions that I've scanned in this forum. So, nothing really groundbreaking about that.
After looking into Global Project Linking, I think my best bet is to still have everything in a single Flare project and just have individual HTML targets for each content set. Plus, when the inevitable philosophical reversal comes a few years down the road, that will make things easier.
I'm working up a POC at the moment. As of now my two main questions are:
#1 - Output Structure
Right now the help is deployed in an Amazon S3 bucket. I believe it is configured to launch /Content/Home.htm by default. So, I'm thinking this means that the Portal Home still has to be in the root, and the output of the other modules have to be in a subfolder of that output. What is the best way to structure that?
#2 Linking
How do I need to format cross library links so that they will work? The obvious way seems that they need to be relative hard coded links to where I know the output will live on the server. Is there any way to make that automatic?
Thanks in advance for any thoughts and advice.