Website Documentation EIT, Author Gay Robertson, 2018
End-user documentation This document is to assist the end users with the use of your website. Although your website may feel self-explanatory, it can be essential to have some documents or instructions to reference when, or if you need them This document should include: Purpose of the website How the navigation works Explaining the functions, how to use or access the website Overview of the content within each page
Developer Notes Developer notes are contained in a document created by the developer, to assist any others who may take charge of the website or have to add to or change the website Developer notes should consist of the following details: The mark-up language the website uses Reasons for choices made What features and functions are included? Visual information such as colour scheme, fonts, styles, images used and where the original files are stored
Documentation formatting Your documentation should always be in a clear and professional layout that is easy to follow and understand Your client will judge the website by the quality of the documentation given with it It is best to present it both as a hard copy (printed) and a softcopy (such as a pdf)
Stakeholder approval and signoff Once the website is designed, developed and tested, it is time to hand the final product over to the client You provide the client with the end user documentation and a sign-off letter, allow the client time to review the product as they may need to share it with the rest of the business Once reviewed, the website is completed and signed off If you are offering continued support then you will get in touch with them again at an agreed time Itis a good idea to ask for a review or testimony from clients - this means you can show your work and the quality of your work to new and future clients
End of presentation Press Esc