Published by Mijingo

tips icon image

EE Insider Tips
Sponsored by Mijingo's EE 2 Screencasts

ExpressionEngine mini-howtos created by the EE Insider community.

Don’t Forget the Docs!

  • Posted by Erik Reagan
  • May 12, 2009

When creating client projects it’s very simple to overlook something like documentation. It’s important to include docs for your clients because in the long run it not only saves everyone time - but also shows an extra level of commitment and professionalism on your behalf.

Take the time to create a documentation weblog and find a creative way of allowing access to it either through a “member group only” link built into the site or perhaps a specific section in the control panel (added as an extension or module).

Bridget15:38 on 05.25.2009

Agreed that this is an important step in the process. I would love to hear some advice on what you do to create a meaningful (chronological?) order to your client docs. How do you structure your table of contents?

Sean Smith14:37 on 05.29.2009

Interesting. I usually create a pdf with screenshots that I send to the client. I might actually move to a documentation weblog.

Kenny Meyers08:44 on 05.31.2009

Also, a little self-promotion here. I created a set of templates that will allow you to easily setup documentation on your client website.

http://github.com/kennymeyers/EE-Documentation/tree/master

You can download them and use them all you like.