<html xmlns:v="urn:schemas-microsoft-com:vml" xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:w="urn:schemas-microsoft-com:office:word" xmlns:x="urn:schemas-microsoft-com:office:excel" xmlns:m="http://schemas.microsoft.com/office/2004/12/omml" xmlns="http://www.w3.org/TR/REC-html40">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Generator" content="Microsoft Word 15 (filtered medium)">
<style><!--
/* Font Definitions */
@font-face
{font-family:"Cambria Math";
panose-1:2 4 5 3 5 4 6 3 2 4;}
@font-face
{font-family:Calibri;
panose-1:2 15 5 2 2 2 4 3 2 4;}
/* Style Definitions */
p.MsoNormal, li.MsoNormal, div.MsoNormal
{margin:0in;
font-size:11.0pt;
font-family:"Calibri",sans-serif;}
span.EmailStyle19
{mso-style-type:personal-reply;
font-family:"Calibri",sans-serif;
color:windowtext;}
.MsoChpDefault
{mso-style-type:export-only;
font-size:10.0pt;}
@page WordSection1
{size:8.5in 11.0in;
margin:1.0in 1.0in 1.0in 1.0in;}
div.WordSection1
{page:WordSection1;}
--></style><!--[if gte mso 9]><xml>
<o:shapedefaults v:ext="edit" spidmax="1026" />
</xml><![endif]--><!--[if gte mso 9]><xml>
<o:shapelayout v:ext="edit">
<o:idmap v:ext="edit" data="1" />
</o:shapelayout></xml><![endif]-->
</head>
<body lang="EN-CA" link="#0563C1" vlink="#954F72" style="word-wrap:break-word">
<div class="WordSection1">
<p class="MsoNormal"><span style="mso-fareast-language:EN-US">Whether I like it or not (NOT!) pretty much everything nowadays just opens a browser to a webpage when you click the Help button, so your options are manifold. I would stick with something standard
like ReadTheDocs.org’s format, even if you don’t host the content there. They support both Sphinx and McDocs.<o:p></o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US">Just… if you do this and host the content externally, PLEASE (a) version your help files in lock-step to the software version, even if that means lots of duplication, and (b) don’t remove old documents
OR in-document anchors. People out there will use friggin’ ancient versions of your software, but that doesn’t mean the don’t deserve documentation. With a giant banner telling them they’re now “7 YEARS OUT OF DATE”, sure, but at least leave the docs online!<o:p></o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US">Tangentially, ReadTheDocs has some decent Sphinx resources…<o:p></o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US"><o:p> </o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US">-Adam<o:p></o:p></span></p>
<p class="MsoNormal"><span style="mso-fareast-language:EN-US"><o:p> </o:p></span></p>
<div>
<div style="border:none;border-top:solid #E1E1E1 1.0pt;padding:3.0pt 0in 0in 0in">
<p class="MsoNormal"><b><span lang="EN-US">From:</span></b><span lang="EN-US"> Roundtable <roundtable-bounces@muug.ca>
<b>On Behalf Of </b>Brock Wolfe<br>
<b>Sent:</b> Saturday, January 21, 2023 10:34 AM<br>
<b>To:</b> roundtable@muug.ca<br>
<b>Subject:</b> [RndTbl] Help and Documentation System Development<o:p></o:p></span></p>
</div>
</div>
<p class="MsoNormal"><o:p> </o:p></p>
<p><span style="font-size:13.5pt;font-family:"Courier New"">I am looking at alternatives to the Adobe Robohelp help/documentation system development software.</span><o:p></o:p></p>
<p><span style="font-size:13.5pt;font-family:"Courier New"">Are there any recommendations over the many open source packages that exist?</span><o:p></o:p></p>
<p><span style="font-size:13.5pt;font-family:"Courier New"">I have looked briefly at Sphinx. Has anyone got any experience with this package?</span><o:p></o:p></p>
<p><o:p> </o:p></p>
<p><span style="font-size:13.5pt;font-family:"Courier New"">Many thanks in advance for your suggestions and comments.</span><o:p></o:p></p>
<p><o:p> </o:p></p>
<p><span style="font-size:13.5pt;font-family:"Courier New"">Regards</span><o:p></o:p></p>
<p><span style="font-size:13.5pt;font-family:"Courier New"">Brock</span><o:p></o:p></p>
</div>
</body>
</html>