HTML template documentation


#1

Is documentation necessary for a HTML template? If so, is commenting on javascript,html and css files enough. or do you need to create a documentation folder and put a pdf or html file guiding the buyer how to start using the template? If so, what all things should I include in the documentation file?


#2

Yes it is a requirement for ALL files types.

JS/CSS commenting is helpful but basic guidelines on how/what to edit esp. key things like logo, editing images, adjusting CSS etc.

Without seeing the file in question it is hard to give detail.

There’s a template here https://help.market.envato.com/hc/en-us/articles/202500894-Helpful-Resources-for-Authors


#3

Yes - you need documentation and put it on folder Documentation when you ship your item.

Great tool for visual exporting documentation is http://revaxarts-themes.com/documenter/ and many authors use it. There are other great templates( shared here on the forums as well ) for making documentation but you will need to edit the html itself.:slight_smile:


#4
efbou said

Is documentation necessary for a HTML template? If so, is commenting on javascript,html and css files enough. or do you need to create a documentation folder and put a pdf or html file guiding the buyer how to start using the template? If so, what all things should I include in the documentation file?

Let me tell you how we find out the way to start back in the past. Just give the very first wise investment buying some good html template here. Not only documentation, you will find more great other things that push you much faster to be an author here.