33 posts
  • Bought between 10 and 49 items
  • Exclusive Author
  • Has been a member for 5-6 years
  • Sold between 5 000 and 10 000 dollars
  • United Kingdom
flips says

Hey all,

I am about to release 3 site templates in the next couple of days and was looking into the things required in the zip files. This got me thinking about documentation and I couldn’t think (writers block) of the kind of things to include in it for the end user really. Advice/Example?

Appreciated, Jim

1417 posts
  • Envato Staff
  • Has been a member for 5-6 years
  • Senior Reviewer
  • Sold between 10 000 and 50 000 dollars
  • Attended a Community Meetup
  • Contributed a Blog Post
  • Contributed a Tutorial to a Tuts+ Site
  • Exclusive Author
+10 more
kailoon Reviewer says

I think you just try to explain A-Z is better ;)

33 posts
  • Bought between 10 and 49 items
  • Exclusive Author
  • Has been a member for 5-6 years
  • Sold between 5 000 and 10 000 dollars
  • United Kingdom
flips says

Wow someone’s on the ball this morning, that was a quick reply :) thanks.

I’ve just found in projects in the past it’s sometimes easy to fall into the document everything trap and it all gets a bit too much for the end user. It’s been a while, but I’m certainly going to give it a good blast. If someone does want to chip in and share with us an example or guide, I’m sure it would help those of us that are stuck.

Don’t you find it’s easier to design than document? :)

1417 posts
  • Envato Staff
  • Has been a member for 5-6 years
  • Senior Reviewer
  • Sold between 10 000 and 50 000 dollars
  • Attended a Community Meetup
  • Contributed a Blog Post
  • Contributed a Tutorial to a Tuts+ Site
  • Exclusive Author
+10 more
kailoon Reviewer says

What I am talking about isn’t a very long instruction for the end users. it is basically guide them how to use the theme correctly.

For example: For ‘noob’ users, they may not know how to use the custom fields in WordPress.

For ‘experienced’ users, they know, but you still need to provide the ‘key’ for them.

Some even have different sidebar for different pages. So, documentation is actually the guideline to use the theme they purchased.

Try to think on behalf of the user who is going to pay for your product then you will find the best way to write the documentation :)

by
by
by
by
by
by