division_line.jpg

In today’s world, professional high quality documentation is a must for companies operating nationally and internationally.

Documentation means hard copy, online documents, online help, quick start guides, and other written instructional information. The need for documentation is often an afterthought when designing products.

division_line.jpg

Instructional Design example | The M2 (Lausanne's metro) schema

Instructional Design example | The M2 (Lausanne's metro) schema

division_line.jpg

Product development engineers are so enmeshed in creating the product that they feel its use is "intuitive" or self-evident. This assumption is usually not the case. In many respects, documentation compensates for the lack of intuition. It permits understanding the product and provides a quick source for looking up specific details that are not immediately obvious to the user.

All documentation is not created equally. It is important to offer the information that is needed by the user rather than focusing on the product and covering each function without regard to the user. So a user-centric approach is necessary to create effective documentation. This is not much different from an Instructional Design process where the purpose is to train the user.

Good documentation can make a product easy to understand and use which results in greater user acceptance. The proficiency of your print and on-line documentation will have an impact on other areas, helping you to structure your information better.

By utilizing a cutting edge instructional design approach, I can authoring any subject to any size group anywhere in the world, including:

  • Quick Reference Guides;
  • Standard Operating Procedures;
  • User Guides;
  • Technical Manuals;
  • Blended Learning Solutions;
  • Project Lifecycle Documentation;

I develop documentation for a wide range of products from high-tech to banking products. I determine and develop solutions using industry standards and methods such as:

  • Participating in the product planning process to identify necessary document creation and modification tasks then carry out those tasks aiding and with the aid of the engineering team;
  • Reviewing published materials and recommend revisions or changes in scope, format, content, and methods;
  • Maintaining existing documentation including but not limited to guides for installation, product use and development, product administration and other externally consumed documents including product release notes;
  • Providing feedback and suggestions to improve internal technical and architectural documentation;
  • Defining and executing standards in documentation process and content;
  • Organizing material and completes writing assignment according to defined standards regarding order, clarity, conciseness, style and terminology;
  • Coordinating testing software and documentation for usability, logic and accuracy;
  • Selecting and creating photographs, drawings, sketches, diagrams and charts to illustrate material.

My knowledge base is comprehensive and I use software and applications such as MS Word, PowerPoint, InDesign, QuarkXPress, Photoshop, Illustrator and many others.

division_line.jpg

division_line.jpg