Best Practices, Standards and Documentation: Success through Pedantry

Presentation from JNUC 2018, the world's largest rally of Apple IT administrators.

Session:
Best Practices, Standards and Documentation: Success through Pedantry

Presented by:
Miles Leacy, Walmart

View all session slides, recordings and more at https://www.jamf.com/events/jamf-nation-user-conference/2018/.

Transcript

2. © JAMF Software, LLC Miles Leacy Technical Expert, Apple Technology Walmart 275x275 head shot
3. © JAMF Software, LLC Best Practices, Standards and Documentation: Success through Pedantry Presentation agenda: Primer Clarity Best Practices Processes Empowerment
4. © JAMF Software, LLC Primer /ˈprimər/ noun
 an elementary text that serves as an introduction to a subject of study
5. © JAMF Software, LLC Pedant /ˈpe-dᵊnt/ noun
 a formalist or precisionist in teaching
6. © JAMF Software, LLC Formal /ˈfôrməl/ adjective
 officially sanctioned or recognized
 
 synonyms: authorized, approved, validated, documented, recognized, authoritative
7. © JAMF Software, LLC Precision /prəˈsiZHən/ noun
 the quality, condition, or fact of being 
 exact and accurate
8. © JAMF Software, LLC Lexicon /ˈleksiˌkən/ noun
 the vocabulary of a person, language, or branch of knowledge
9. © JAMF Software, LLC Clarity Why is all of this important?
10. © JAMF Software, LLC We Are All Educators • Our users • Our internal partners • Our subordinates • Our superiors Who are our students?
11. © JAMF Software, LLC Cognitive Load Effort being used in working memory
12. © JAMF Software, LLC Working Memory 4-5 bits of new information at a time
13. © JAMF Software, LLC Extraneous Load • Reconciling duplicate & inconsistent terms • Irrelevant or mismatched information Distractions and unnecessary thought
14. © JAMF Software, LLC Extraneous Load Reconciling duplicate & inconsistent terms Imaging Thin Imaging OS-only imaging Monolithic Imaging Component Imaging Modular Imaging
15. © JAMF Software, LLC Reducing Extraneous Load • Apple Style Guide
 https://help.apple.com/applestyleguide/ • 3rd-Party Documentation • Organization’s Style Guide • Manuals of Style The Mac Admin’s Lexicon
16. © JAMF Software, LLC Extraneous Load The Terminal Irrelevant or mismatched information Install the Package 1. Download the package 2. Packages can be bundles or flat files 3. Double-click the package
17. © JAMF Software, LLC Reducing Extraneous Load Profiles Preferences Minimum information, matching images & text Install the Package 1. Download the package 2. Double-click the package 3. Select Continue …etc.
18. © JAMF Software, LLC Best Practices • Use the tools • Fill gaps, don’t reinvent wheels • Costs of deviation • Positive contributions only Get out of your own way
19. © JAMF Software, LLC Processes Start With Why, Then Start Documenting
20. © JAMF Software, LLC Max image dimensions After Why, What and How Every project begins with a flow chart.
21. © JAMF Software, LLC Documentation • Engineers • Support Staff • End Users Audiences
22. © JAMF Software, LLC Documentation • What did we do? • Why did we do it this way? • How did we do it? Engineers
23. © JAMF Software, LLC Documentation • How is it supposed to work? • How could it go wrong? • How can we fix it when it does? • What do we do when we can’t fix it? Support Staff
24. © JAMF Software, LLC Documentation • How is it supposed to work? • How could it go wrong? • How can we fix it when it does? • What do we do when we can’t fix it? End Users
25. © JAMF Software, LLC Review Period • The Why • The Process • The Documentation Review it all regularly
26. © JAMF Software, LLC Empowerment • Share information • Publish resources • Remove bottlenecks Build success into the team
27. © JAMF Software, LL THANK YOU!