End User Guides
Original Documentation
Often times I am tasked with revamping old documentation. Dissecting a large document can be daunting. But with the right touches, this software guide can be visually appealing and effective for the end user.
For example, you will see the documentation uses terms such as 'sign in' while the button text is 'Login'. Details such as this are important.
Enhanced Documentation
Selecting user scope when writing documentation is important to the documents overall efficiency. For example, when an office migrates to well known software, there is a plethora of information available, however, the documents should only cover what and how your company will use the application. The documents need to be structured in a user friendly layout so information can quickly be found, and written in a way that your target audience can understand and benefit from.
Title Page
The title page has been re-designed to put the focal point at the documents title. The version history and date have been moved out of the main focal point as they are primarily important for the technical writer or company. The header still allows this title page to be visually appealing while using contrasting colors that are visible in the company's logo. Using a custom header allows the document to be branded to the company.
Content
The content has been broken down and re-written, while still being consolidated to one page. Using proper section titles will make locating information in the table of contents on larger documents a breeze. Formatting key words in bold will allow the user to quickly skim the document and pick out the information they need to know. Adding images to steps allow visual learners to easily pick up on the process. Placing a border around the image breaks up content and distinguishes images from text, while adding callouts such as the letters, numbers, and red boxes allow the user to easily follow along with the text documentation.
