Learn More About Me...

  • 692 views
Uploaded on

Overview of Technical Documentation Overview for Tresha Daise-Russ

Overview of Technical Documentation Overview for Tresha Daise-Russ

More in: Business , Education
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Be the first to comment
    Be the first to like this
No Downloads

Views

Total Views
692
On Slideshare
0
From Embeds
0
Number of Embeds
1

Actions

Shares
Downloads
0
Comments
0
Likes
0

Embeds 0

No embeds

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
    No notes for slide
  • About technical documentation

Transcript

  • 1. Technical Documentation
    Educating Today’s Global Workforce
    Tresha Daise-Russ, M.B.A.
    954.288.8411
    tdaise7@gmail.com
  • 2. Technical Documentation
    Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer
    About Me
    Over 10 years of Technical Documentation Experience.
    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.
    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.
    Conducts Subject Matter Expert requirement gathering interviews.
    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.
    End-UserDocumentation
    SDLC Documentation
    ProjectManagement
    Agile TechnicalDocumentationMethodologies
    Software Product Training
    ContentManagement
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    Educating Today’s Global Workforce
  • 3. Technical Documentation
    Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer
    Additional Expertise
    Establishes and maintains project documentation libraries, including the use of version control software. Trains other team members on versioning products.
    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.
    Responds with urgency to requests from Technical Support and the Sales teams for additional documentation and product training materials.
    Solicits and receives ongoing critiques of all documents produced while maintaining a positive attitude and professional demeanor.
    Demonstrates strong communication and interpersonal skills, with the ability to interact frequently with project managers, software developers, software testers, and other information developers.
    DocumentationLibraries
    Microsoft Office & SharePoint
    Team Foundation Server
    Help Desk and Sales Support
    Peer Reviews
    Social MediaContent
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    Educating Today’s Global Workforce
  • 4. Technical Documentation
    Agile Technical Documentation
    Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer
    Narratives and Functional Specifications
    Process Flow and Logic Diagrams
    Input/Output Samples
    QA Test Cases and UAT Test Cases
    Microsoft
    Definition & Design
    Online Help
    User’s Guide
    E-Learning Videos
    Quick Reference Guides
    Development & Validation
    Adobe
    Release Notes
    Training Guides
    Internal Product Training
    Social Media Content
    Microsoft & Adobe Products
    Deployment
    (e.g., Help Desk, Sales, and Marketing team members)
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    AUTHORING TOOLS
    Educating Today’s Global Workforce
  • 9. Technical Documentation
    Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer
    Single Source Expert
    One Source
    Multiple Deliverables
    In today’s global marketplace, where businesses are operating across
    borders and time zones, customers demand that accurate, relevant
    product information be delivered in real-time.
    TrainingManual
    Mobile
    PDF
    User’s Guide
    Website
    Single
    Source
    Help Desk
    Quick References
    VideoTutorials
    Online Help
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    Educating Today’s Global Workforce
  • 10. Technical Documentation
    Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer
    Software Simulation VideosE-Learning
    VideoSplash
    Screen
    Learners can navigate through Video: Pause, Play, Forward and Back
    Navigate throughSoftware.
    Explain use cases or scenarios.
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    Educating Today’s Global Workforce
  • 11. Technical Documentation
    Educating Today’s Global Workforce
    Online Help
    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.
    Full Text Search
    NavigationToolbar
    Breadcrumb
    Books
    Pages
    TopicContent
    Sub-Chapters
    Launch Help from Support Portal
    or inside software
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    10 Years of Technical Documentation Experience
  • 12. Technical Documentation
    Tresha Daise-Russ, M.B.A. ǀ 954.288.8411 ǀ tdaise7@gmail.com Sr. Technical Writer, Business Analyst and Trainer
    Quick Reference Guides
    Typical Layout
    Topic Introduction
    Icon & Name Descriptions
    Step-by-step Instructions
    • Double-sided
    • 13. 4 Color
    Introduction tomodule topic
    Important Tip /
    Reminder
    How-to Instructions
    Individual IconDescriptions
    Construction Iterations
    Release Iterations
    Release Iterations
    Retirement
    Production
    Project Planning ǀ Requirements ǀ Design ǀ Development ǀ Testing ǀ Acceptance
    Iteration 1
    Iteration 0
    Educating Today’s Global Workforce