No software is complete without documentation and because tools are often sent to other GIS users, they need additional "end-user" documentation. This should include, at a minimum:
A "ReadMe" file or "ReadMe.txt" file is a simple file that appears in a folder and gives instructions to the user on what they should do with the folder. Because you may be sending your tools to users that are far afield, you need to add one of these files. It is a simple text file that can be made with NotePad or NotePad++ and should contain:
On the first page of the "Properties" dialog for the tool, you'll see a "Description" field. This text will appear next to the tool's parameters in the tool dialog. This is the same help you've used to get help with tools so make sure to describe your tool from the user's perspective and include any information they may need.
If you right click on the tool and then select "Item Description", you'll be able to edit the "metadata" for the tool. This looks very similar to a data set but if you look at the first entry, "Item Description", you'll see there are additional fields for "syntax". Each of your parameters should appear in this section and there is a place for "Dialog Explanation". This is the text that will appear next to the tool's parameters when each parameter is clicked on. This is very important to let your use know what each parameter does and it's limitations.
Let me know if you find a good one.
© Copyright 2018 HSU - All rights reserved.