Documenting my tools and processes

[Hornbydd]

@joewheaton,

Just before Christmas I put the brakes on my development primarily as I was starting to be in the situation of I can't see the wood for the trees. I discussed this with @dsear and have forged onward with documenting my tools as a help file. Every tool/bit of software should have help, in your case you provide it via a website, I have created a CHM file. I'm about 3/4 of the way through creating it and have uploaded the initial version of it to my fork. You can find it here.

• Download the CHM file to your C:\ drive (must be on C:).
• Right click on it > Properties > General tab > then click on Unblock (you only need to do this once).
• Now double click to open it and explore what I have done.

I will be updating this over the next week, I need to add my workflow part. Once this is done, budget allowing, I can continue with development.

[Hornbydd]

I have removed the CHM file from my repository but not the source file, I'm using github as a backup.

The help file has 3 main sections explain the inputs and outputs and a guide listing all the tools and how to use them, finally there is a workflow page describing the sequence of steps.

Example of TOC for help file

The toolbox tools are now numbered to provide a visual clue to what order tools must be run, but be aware that some tools require external tools to have been run prior to the use of the GeoData tools. The overview sequence is the workflow diagram in the help file.

Example of Toolbox numbering to aid use