Writing and Documentation Samples
Here are several documentation samples:
Class Handout, Visio Flow Chart, Point of Sale Use Case, User Guide, and Artifact for the UI.
Class Handout, Visio Flow Chart, Point of Sale Use Case, User Guide, and Artifact for the UI.
Class Handout- Creating a Nine Stone Bracelet
This is a student handout for a class written by Janet Alexander Additionally, all photos shot by Janet Alexander.
Learn how to create this beautiful heirloom nine stone bracelet; it’s one you’ll treasure for years. Learn the basics of stone setting, cutting seats using a heart bur, setting stones in shared prongs, the parts of a round brilliant stone, soldering chains, polishing chain using a tumbler, and polishing your metal to a high shine using a buffing wheel. Janet explains the different buffs, polishes, and wheels for polishing settings. She also shows how to use a tumbler, and steam machine.
Visio- Process Flow Chart Sample
This is documentation for a process flow for a point of sale software. In this process the end user looks up a customer in the system. This shows the choices the user may select and then the process after selection.
Use Case Sample - Lookup Customer
This is an example of the point of sale documentation for the same function as the wire frame.
User Guide Sample - for Lookup Customer
About This Sample Guide
This is a sample user guide for a factious banking system. The UI is a place saver. The original screen shot would inserts here.
Due to the nature of building software, the user guide requires updates along with the system updates. The first page has a revision history table listing the changes made to the chapter. This revision history keeps track of change requests that impact the user guide.
Steps in the user guide are created from analyzing the business analyst’s use case, process flow, and artifact table listing the UI components. As the system is created, the user guide is updated with captured screen graphics.
In my job with Cash Americas, the draft user guide was reviewed by the subject matter experts (SME) because they had a hard time understanding the use cases and other documents. This document allowed them to step through their process flow in a way they understood.
This is a sample user guide for a factious banking system. The UI is a place saver. The original screen shot would inserts here.
Due to the nature of building software, the user guide requires updates along with the system updates. The first page has a revision history table listing the changes made to the chapter. This revision history keeps track of change requests that impact the user guide.
Steps in the user guide are created from analyzing the business analyst’s use case, process flow, and artifact table listing the UI components. As the system is created, the user guide is updated with captured screen graphics.
In my job with Cash Americas, the draft user guide was reviewed by the subject matter experts (SME) because they had a hard time understanding the use cases and other documents. This document allowed them to step through their process flow in a way they understood.
Use Case Artifact Sample
This is an Artifact Excel Sheet. It lists the UI elements and buttons on the computer screen and the actions that occur when selected. The Artifact, assigns UI elements a number so while in meetings team members refer to the number creating less confusion. Additionally, the actions, shortcut key, and focus numbers are listed in the Artifact.
©2006-2018 Janet Alexander Designs. All rights reserved. This site and all jewelry designs, artwork, and information are protected under copyright law. Reproduction in whole or part are prohibited.
