Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

A Method for the Madness: Managing Complex Documentation Projects

129 views

Published on

Presentation for my STC 18 project management panel, covering taxonomies and simplified UI graphics

Published in: Technology
  • Be the first to comment

  • Be the first to like this

A Method for the Madness: Managing Complex Documentation Projects

  1. 1. A METHOD FOR THE MADNESS MANAGING COMPLEX DOCUMENTATION PROJECTS Jennifer Shumate Technical Writing Supervisor 5/21/2018
  2. 2. ©2018 Weatherford International plc. All rights reserved. THE IMPOSSIBLE PROJECT  One Flare project supports eleven software applications  Over 400 topics, 1000 images, and 400 snippets  Has over 14,000 conditions applied  Started with a Flare project that was a disorganized, chaotic mess 5/21/2018 STC18 2
  3. 3. ©2018 Weatherford International plc. All rights reserved. THREE SIMPLE TIPS  Reuse, reuse, reuse!  Create simplified UI graphics  Develop a strict taxonomy 5/21/2018 STC18 3
  4. 4. ©2018 Weatherford International plc. All rights reserved. SNIPPET-ONLY CONDITIONS & VARIABLES 5/21/2018 STC18 4
  5. 5. ©2018 Weatherford International plc. All rights reserved. SNIPPET-ONLY CONDITIONS & VARIABLES 5/21/2018 STC18 5
  6. 6. ©2018 Weatherford International plc. All rights reserved. SNIPPET-ONLY CONDITIONS & VARIABLES 5/21/2018 STC18 6
  7. 7. ©2018 Weatherford International plc. All rights reserved. ONE MODULE IN TWO APPLICATIONS – WHAT TO DO? 5/21/2018 STC18 7
  8. 8. ©2018 Weatherford International plc. All rights reserved. SOLUTION: SIMPLIFIED UI GRAPHICS 5/21/2018 STC18 8
  9. 9. ©2018 Weatherford International plc. All rights reserved. WITHOUT A TAXONOMY – CHAOS! 5/21/2018 STC18 9
  10. 10. ©2018 Weatherford International plc. All rights reserved. WITH A TAXONOMY – ORGANIZED CHAOS! Topics Images 5/21/2018 STC18 10 Snippets
  11. 11. ©2018 Weatherford International plc. All rights reserved. SAMPLE TAXONOMY RULES  3-4 letter prefix for each subject area  3-4 letter abbreviation for each application or purpose  Snippet and image file names match the file name for the related topic  An identifying word for common sections, such as introductions, field definitions, and button definitions. 5/21/2018 STC18 11
  12. 12. ©2018 Weatherford International plc. All rights reserved. CONTACT INFO & RESOURCES  Contact info – Twitter: @Jen_Shumate – Email: Jennifer.Shumate@weatherford.com  Taxonomies – The Accidental Taxonomist by Heather Hedden  Reuse – https://www.madcapsoftware.com/blog/2012/02/15/tweaking-the-content-inside-of- snippets-using-conditions/ – https://blogs.adobe.com/techcomm/2013/05/trends-levels-of-re-use.html – https://blogs.adobe.com/techcomm/2015/02/keeping-it-clean-ways-to-streamline-content- in-robohelp.html  SUI Graphics – https://www.techsmith.com/blog/devcorner-simplified-ui-sui/ 5/21/2018 STC18 12

×