In conjunction with any technical project I take on, I often take the lead in putting together the end-user documentation and participating in end-user training with clients.
My comprehensive documentation generally includes step-by-step annotated screenshots of back-end administrative screens and essential information for future developers tasked with adding additional functionality. Since most websites are constantly in a state of flux, I provide both a pdf and word formatted version of my documentation so that they can modify it as changes are rolled out. A general outline/Table of Contents for my website documentation is listed below:
- Information About Your Website & Hosting Platform (DNS, Web-hosting, FTP, Email Services)
- User Management
- Intro to the CMS Lingo and an Outline of Your Custom Content Types/Data Structures
- How to Manage Your Content (posts/articles, pages, , etc)
- Overview of Site-specific features including:
- Menu Items, Sidebar Blocks, Slider Images
- Contact Form Management
- Location Management
- Event Management
- General Notes for Managing/Maintaining Site (Plugins, Themes, Core Patches/Updates, Backups)
In addition to preparing and issuing end-user documentation, I have provided both on-site and remote training, allowing the site-administrator(s) to have a first-hand experience with the customized CMS or application.