documentation is key.

I am in the process of finishing up a project for my consulting company and one of the final things I do before handing over everything to my client is to provide detailed documentation of what I did, how I did it, and how to modify what I created. Why? I feel it is very important to empower my clients by giving them solutions they can maintain or that the very least – make minor but important changes (navigation changes, content changes, etc). After finishing up the documentation tonight, I decided to centralize my documentation for my clients by setting up MediaWiki (my wiki of choice) and then setting up access to different clients. By using a wiki, I can easily maintain the documentation I have done for all my projects (a good reminder of what I did when I need to update/change my code in the future, as well as I can have the clients add personal notes, etc on what they have found to work. I will install and set up the wiki this weekend and then start moving over my documentation from all my current clients so I can get them using the wiki. I hope this works out!
[tags]wiki, MediaWiki[/tags]

About the Author...

Jennifer Zelazny

My name is Jennifer Zelazny and this site is a collection of my random thoughts and opinions. I am Penn Stater, WordPress developer, and a modern day explorer. I love exploring data, trends, and things that make the world a better place and sharing them here.

2 thoughts on “documentation is key.”

  1. apokalyptik

    Good girl! Helps to be able to charge for it too doesnt it? 😉 😀 MW is great, Out of curiosity how do you plan to manage the ACL’s so that client X cant see client Y’s docs (or even that you have client Y?) Different MW installs, or a very complex set of htaccess rules?


  2. jenz

    Good question. I was hoping there would be a MW extension to take care of view permissions…this weekend will be my research time.

Leave a Reply

Your email address will not be published.
You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

This site uses Akismet to reduce spam. Learn how your comment data is processed.