If I submit an HTML site template that uses jQuery, for example, do I need to explain how to edit the back-end code (I.E. functions) in my help file, or can I simply explain how to link it to the main HTML code and point users to another freely-licensed resource that explains it if I’m not experienced with it and can’t support it?
Not everyone who purchases scripts here has programming knowledge. It’s good to be as detailed and thorough as possible.
I like to take screenshots of every step from beginning to end. You can never be too detailed or include too much info.
Deatils my friend, details.
I personally list all JS files in my help documentation and then supply a link to the items authors page (obviously if this is an open source script) where the user can see detailed instructions and see comments / join in however I then supply support if someone for example wants to change the rotation from manual to automatic on a scroller – I usually include the breakdown of the functions just like they would get from the jquery author – I find it best that users can see where a script came from and normally the author does a better job than I ever could – plus I feel it’s important to pass an end user through to that scripts author as a link back – I would want the same to be honest.
Rule of thumb is that if someone else built it and knows it better than you then their community can offer better support and experience for your buyer than you ever could.
The main parts of your help documentation that should be covered as well as possible is the HTML and CSS . Explaining the structure of these sections is important so buyers can quickly and easily get caught up on how you’ve built the template.
A detailed help file is very helpful for buyers so the more details the better. Also be sure to comment your markup as best as possible as that will really help unexperienced buyers use your template.
Hope this helps!