How-To Wiki now available
We're pleased to announce the immediate availability of Perceptive Automation's How-To Wiki
. The purpose of the wiki is to provide clear descriptions and detailed how-tos for our products. The Indigo Mac client has links to specific How-To topics from the Help menu (particularly when a device is selected), and also from the help button on the device dialog. Otherwise, please use the search feature or just browse! You'll find good information there, and more will be added as time goes by. And, if you DON'T find what you're looking for, you can still search here through the forums. If you still don't find it, either post a question, or recommend a page be added to the Wiki by posting a request to this forum (no guarantees about getting one written up though
We created this area using the open source Dokuwiki
system to enable collaboration from our very active user community. The forums have been the repository for this information in the past, but we feel that the wiki approach will allow users to find common step-by-step solutions and explanations more quickly than searching through the forums. If you've done something cool we'd love to have your How-To on the site.
If you figure out the solution yourself, write up a How-To for it! To become a contributor, click the login link below and then click register. Then, once you've registered, please send an email to indigo DASH support AT perceptiveautomation DOT com with your username asking to become a contributor. We need to do this last step manually to prevent spammers from junking up the pages.
====== How-To Formatting Suggestions ======
Here, we'd like to make some suggestions around formatting a How-To. Please review the syntax page
to view the specifics about wiki markup.
- Try to use the "Ordered List Item" button in the editor. This will create a nice numbered list. The goal is to create a page that a user less experienced than you can use to implement your feature. Simple numbered steps make this much easier. Some How-To articles are more for background and don't really lend themselves to ordered list - that's OK too, just make sure you use the appropriate approach for your How-To.
- Some say a picture is worth a thousand words. And, that may be the case with your solution. To help keep bandwidth usage down and available disk space up, please use pictures judiciously and make sure they're as small as you can make them and still be useful.
- When in doubt, always over-explain what to do or what a step will accomplish. This will not only make your How-To more successful, but will hopefully educate the user.
- Having said the last point, limit alternative ways of performing a particular action. If there are 3 different ways of accomplishing a task, pick one and be consistent. Choice is good, but inexperienced users who are looking for a specific solution don't need to know that there are multiple ways of accomplishing a task. Remember, they just want a solution to a problem as quickly as possible.
- Various solutions are inherently gonna be harder than others. So, you should give the user an up-front estimation of how difficult something will be following the standards here: How-to level of difficulty
If you follow these suggestions as closely as possible, users will be able to use and understand your How-To quickly and the community as a whole will become even more knowledgeable!