EDIT for clarity: this feature request is a market-discriminator. If Fogbugz can't help me here, I have to go with another product. This would be a huge disappointment as I already have Fogbugz in front of the technical experts working on the system. I'd like to make it easy for them to produce the parallel documentation. Fogbugz is a great tool for producing content. It's just the final deployment mechanism that is tripping us up.
I am looking for a Fogbugz plugin or workflow that would allow us to generate our online help text using the built-in Fogbugz wiki, export it to static HTML and then deploy it to remote no-network sites. We had been having the domain experts (who are also the developers) generate the text, after which documentation staff would import the text and format it in Robohelp, deploying to static HTML.
I'd like to eliminate that Robohelp step as it adds complexity without value.
The documentation requirements for our application are fairly straight-forward:
- Each dialog box, major display, etc., has a "get help" button that we would like to be context sensitive: we'd like to click that button and be looking at the relevant content with minimal scrolling.
- Our system has enough visual complexity that it's worth having a screenshot embedded in the documentation to serve as reference: e.g., the column that you see here with this name has values in it that refer to this measured quantity.
- We have a few links between documents where it makes sense. For example, some of our displays slice and dice the same data in different ways. "This number in this display means the same thing as this vertical bar in this histogram," etc.
- We run our system on several flavors of Windows and Linux so we'd prefer platform independence.
I would like to be able to produce the documentation in the Fogbugz wiki: that allows our developers (who are also the technical experts) to prepare the source material, respond to requests for clarification and so forth straight for their desks. At the same time, a documentation prep person can put boilerplate or standard formatting using the same wiki.
Here's what we're doing now:
- Technical person writes original words in the wiki with relevant screenshots.
- Documentation person copies that material into a Robohelp project using one of our limited number of Robohelp licenses.
- Robohelp project is built into documentation during the CruiseControl-driven build process. Note: this builder application is Windows-only which is very frustrating since I would prefer to have an all-Linux production process.
So, the question is: can we get from the Fogbugz wiki directly to something like Robohelp-esque output? We don't need complicated features, user-defined tags or even fancy formatting. I'd be happy if we could just get our words and screenshots prepared with a little less frustration (and cost).
EDIT: Additional comment for clarity - currently, if the user clicks the question-mark button in our application, a browser appears with the context-appropriate online help material. Robohelp is the production mechanism used to produce the static content that appears in the browser. If there were another method to produce the static content directly from the wiki, we could eliminate the need for Robohelp entirely.
EDIT: Responding to one of the answers below suggesting that the deployed system access our Fogbugz repository dynamically and present the wiki content over the web. Sorry, this isn't possible. The Fogbugz wiki and the deployed system run on disjoint networks thousands of miles from each other. There is also a zero percent chance that I could deploy a complete copy of the Fogbugz system to the remote site. The request information stands at: how can we export the content from the wiki into a form readable by our remote system?