14 Mar 2007 12:00 AM EDT

posted by Andy McAleer

A big thank you to everyone who replied to my previous questions about accessing Citrix documentation. for the second and final set of questions in this about your documentation preferences. Remember, there a small, randomly drawn prize open to anyone who takes part. All you have to do is post a reply here, and I will enter you into the draw!

class="MsoNormal" style="margin: 0cm 0cm 0pt; line-height: normal">By the way, summary of the replies received on earlier questions:

  • Not many of you use the docs on the CD directly or install them on servers.
  • Many of you use the web to access and update docs.
  • Other information sources (such as Brian Madden site) are helpful.
  • The IBM and Adobe of documentation delivery worth checking out.

So, other questions I have for you... concern the different publishing formats that we use at Citrix. A few of you have already touched on this, but I thought it was worth asking explicitly about file formats because they can really influence how you interact with (not just read) content in our publications. Depending on the task you performing (planning, installing, troubleshooting, etc.), different doc formats are more suitable than others. Furthermore, product documentation in different may affect how your organization shares and there may even be security implications. In short, formats are important.

Which formats do you prefer, and why?

Citrix publishes product documentation in a variety of formats administrator guides as PDFs, in-product Help systems as compiled HTML Help, readmes as standalone HTML files, and Knowledge Base articles in HTML format on our web site.

Please tell us about any preferences you have. Maybe you don have a strong opinion about this, but try looking at it this way: if you like your guides in PDF format (say, when you planning your Citrix deployment), would it bother you if these guides were only available in HTML format on the Citrix website?

Conversely, if you frequently consult the online Help (say, to check how to fill in a field in a dialog box), would your organization be concerned if the Help were not installed with the Citrix product, but were instead available on the Citrix website? In other words, you need an Internet connection while using the product, but, once connected, you have access to more up-to-date Help topics. Is a permanent Internet connection that available from any Citrix server a constraint for your organization?

Do you prefer reading content on web pages rather than in PDF documents?

class="MsoNormal" style="margin: 0cm 0cm 0pt; line-height: normal">Also, as a matter of interest, have you changed your opinion about publishing formats in the last few years? Maybe you now less reliant on PDF documents than you were a few years ago, and instead favor HTML-based documents.

Please tell us about your experiences, expectations, and desires in this area. We like to hear from you.

Permalink | Comments (5) |

HTML; when you absolutely need documentation to solve an immediate issue, you can always use a generic web browser and not have to use the latest plug-ins for the content you serving.

Make the HTML documentation interactive with your users when the documentation is hosted at Citrix.

PHP.net has the best example of this. Search for and select list from the drop down box and conduct the search. Agreed, this is a coder site and it intent is to give examples of using the code but maybe you can glean some other ideas.

I favor whatever can be saved and referenced later. PDF is probably the most known and used. Adobe Reader is actually installed on all of our servers. So I would have to say PDF is probably my favorite method of distribution.

I prefer PDF as the reader interface is completely familiar to me. With HTML there are so many controls available to a programmer for navigation that the consistency that is delivered by the reader is missing. I would also prefer that the help be referenced from the Citrix website. This is starting to become common practice and promotes instructions becoming a work in progress instead of being pushed out the door before they are ready and then never updated again. Integrating the updated documentation material with the 'My Watches' feature of the knowledge centre would be a nice touch as well. You shouldn't need to publish a KB article everytime you make a minor change to the documentation. An alert that actually showed you what has been updated would be sufficient.

Updated onLine HTML documentation is a good idea... The *problem* is to be notified when change are made...

Yes, personally I would love to see Citrix embrace RSS for updates. Although are better than nothing, I prefer the flexibility of RSS feeds.