Successfully reported this slideshow.

Learn More About Me...

916 views

Published on

Overview of Technical Documentation Overview for Tresha Daise-Russ

Published in: Business, Education
  • Be the first to comment

  • Be the first to like this

Learn More About Me...

  1. 1. Technical Documentation <br />Educating Today’s Global Workforce<br />Tresha Daise-Russ, M.B.A.<br />954.288.8411<br />tdaise7@gmail.com<br />
  2. 2. Technical Documentation<br />Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer<br />About Me <br />Over 10 years of Technical Documentation Experience.<br />Professionally researches, writes, maintains, and publishes high-quality print documentation and online content: Online Help, User’s Guides, Quick Reference Guides, E-Learning Videos, and Social Media content.<br />Writes additional product texts: Blog Entries, FAQs, Release Notes, Social Media content (e.g., Facebook& Twitter updates and articles), as well as other product and corporate announcements.<br />Conducts Subject Matter Expert requirement gathering interviews.<br />Develops requirements and analysis documents including: business process descriptions, business rules and business requirements, process flows and scenarios, functional requirements, design specifications, QA / testing procedures, QA test cases, and UAT test cases.<br />End-UserDocumentation<br />SDLC Documentation<br />ProjectManagement<br />Agile TechnicalDocumentationMethodologies<br />Software Product Training<br />ContentManagement<br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />Educating Today’s Global Workforce<br />
  3. 3. Technical Documentation<br />Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer<br />Additional Expertise<br />Establishes and maintains project documentation libraries, including the use of version control software. Trains other team members on versioning products. <br />Responds with urgency to requests for information and technical assistance. Assesses the gaps in existing product documentation and training materials to mitigate future technical support issues. Updates issue tracking software with relevant details to help other departments resolve customer issues. <br />Responds with urgency to requests from Technical Support and the Sales teams for additional documentation and product training materials.<br />Solicits and receives ongoing critiques of all documents produced while maintaining a positive attitude and professional demeanor.<br />Demonstrates strong communication and interpersonal skills, with the ability to interact frequently with project managers, software developers, software testers, and other information developers.<br />DocumentationLibraries<br />Microsoft Office & SharePoint<br />Team Foundation Server<br />Help Desk and Sales Support<br />Peer Reviews<br />Social MediaContent <br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />Educating Today’s Global Workforce<br />
  4. 4. Technical Documentation<br />Agile Technical Documentation<br />Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer<br />Narratives and Functional Specifications<br />Process Flow and Logic Diagrams<br />Input/Output Samples<br />QA Test Cases and UAT Test Cases<br />Microsoft<br /><ul><li>Word
  5. 5. Excel
  6. 6. SharePoint</li></ul>Definition & Design<br />Online Help<br />User’s Guide<br />E-Learning Videos<br />Quick Reference Guides<br />Development & Validation<br />Adobe<br /><ul><li>RoboHelp
  7. 7. Captivate
  8. 8. PhotoShop</li></ul>Release Notes<br />Training Guides <br />Internal Product Training<br />Social Media Content<br />Microsoft & Adobe Products<br />Deployment<br />(e.g., Help Desk, Sales, and Marketing team members)<br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />AUTHORING TOOLS<br />Educating Today’s Global Workforce<br />
  9. 9. Technical Documentation<br />Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer<br />Single Source Expert<br />One Source<br />Multiple Deliverables<br />In today’s global marketplace, where businesses are operating across<br />borders and time zones, customers demand that accurate, relevant<br />product information be delivered in real-time.<br />TrainingManual<br />Mobile<br />PDF<br />User’s Guide<br />Website<br />Single <br />Source<br />Help Desk<br />Quick References<br />VideoTutorials<br />Online Help<br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />Educating Today’s Global Workforce<br />
  10. 10. Technical Documentation<br />Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer<br />Software Simulation VideosE-Learning<br />VideoSplash<br />Screen<br />Learners can navigate through Video: Pause, Play, Forward and Back<br />Navigate throughSoftware.<br />Explain use cases or scenarios.<br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />Educating Today’s Global Workforce<br />
  11. 11. Technical Documentation<br />Educating Today’s Global Workforce<br />Online Help<br />Online help is topic-oriented, procedural or reference information delivered through computer software. It is a form of user assistance. Most online help is designed to give assistance in the use of a software application or operating system, but can also be used to present information on a broad range of subjects. <br /> Full Text Search<br />NavigationToolbar<br /> Breadcrumb<br />Books<br />Pages<br /> TopicContent<br />Sub-Chapters<br />Launch Help from Support Portal<br />or inside software<br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />10 Years of Technical Documentation Experience<br />
  12. 12. Technical Documentation<br />Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer<br />Quick Reference Guides<br />Typical Layout<br /> Topic Introduction<br /> Icon & Name Descriptions<br /> Step-by-step Instructions<br /><ul><li> Double-sided
  13. 13. 4 Color </li></ul>Introduction tomodule topic<br />Important Tip / <br />Reminder <br />How-to Instructions<br />Individual IconDescriptions<br />Construction Iterations<br />Release Iterations<br />Release Iterations<br />Retirement<br />Production <br />Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance <br />Iteration 1<br />Iteration 0<br />Educating Today’s Global Workforce<br />

×