Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for...
Transcript of Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for...
![Page 1: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/1.jpg)
Documentation What are you afraid of?
![Page 2: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/2.jpg)
Mat X
IT Consultant
@macvfx
![Page 3: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/3.jpg)
Why document?
• Bring sanity to ourselves
• Share knowledge with others
![Page 4: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/4.jpg)
Lesson # 1
![Page 5: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/5.jpg)
Document for yourself.
![Page 6: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/6.jpg)
No, really?!
![Page 7: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/7.jpg)
Do you want to ever go on vacation?
![Page 8: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/8.jpg)
Don't get hit by a bus
![Page 9: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/9.jpg)
What are we afraid of?
![Page 10: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/10.jpg)
![Page 11: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/11.jpg)
Lesson # 2
![Page 12: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/12.jpg)
Document for others
![Page 13: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/13.jpg)
SysAdmin or IT consultant?
![Page 14: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/14.jpg)
What do we document?
• Computers
• Network
• Software
• Workflow
![Page 15: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/15.jpg)
What happens if we don't ?
• If there's no documentation
• What if there is a doc but it's not good
• What if it can't be documented
![Page 16: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/16.jpg)
• The system is too complex to document
• No one can do it
• We've hired consultants for the last 6 months
• Visio is the map
Impossible!
![Page 17: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/17.jpg)
Discovery
• What are the systems in place?
• What is the workflow?
![Page 18: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/18.jpg)
/usr/local/bin
/Library/Scripts/
~/bin
![Page 19: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/19.jpg)
Rsync
Carbon Copy Cloner
launchd
plists
shell scripts
python
![Page 20: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/20.jpg)
How do we document all that?!
![Page 21: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/21.jpg)
Bash
% history > ~/saved-cli-'date'.txt
![Page 22: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/22.jpg)
hdiutil create -srcfolder /Library/Scripts ~/m0r3-scripts-`date`.dmg
![Page 23: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/23.jpg)
Notes
![Page 24: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/24.jpg)
Blogs
![Page 25: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/25.jpg)
OS X + Server.app
Wiki
![Page 26: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/26.jpg)
Make pretty pictures
• Omnigraffle
• Illustrator
![Page 27: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/27.jpg)
All your SAN
101010
![Page 28: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/28.jpg)
Ticket systems
• Redmine
• Zen desk
• Web help desk
![Page 29: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/29.jpg)
RedmineOverview, Activity, Issues, Wiki, etc
![Page 30: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/30.jpg)
When do we document?• Continuously!
• During the planning of a new setup
• Discovering facts for an existing setup
• Automatically!
![Page 31: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/31.jpg)
Lesson # 3
![Page 32: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/32.jpg)
DevOps
![Page 33: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/33.jpg)
MacDevOps • Mac IT (Ops) + Dev
• Automation
• Version control
• Repeatable
• Peer review
• Empathy
![Page 34: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/34.jpg)
GitHubWiki, issues, commit messages
![Page 35: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/35.jpg)
![Page 36: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/36.jpg)
Lesson # 4
![Page 37: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/37.jpg)
Sustainability
![Page 38: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/38.jpg)
Living documentation
• Inventory systems
• Asset management
• Automatic reporting
• Use the systems you have
![Page 39: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/39.jpg)
IT management systems• Munki
• Munki Report
• Absolute Manage
• Filewave
• Jamf Casper
![Page 40: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/40.jpg)
Munki + MunkiReport
![Page 41: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/41.jpg)
• Watchman
• Monkeybox
Take it to the cloud!
![Page 42: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/42.jpg)
![Page 43: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/43.jpg)
Lesson # 5
![Page 44: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/44.jpg)
Improve
![Page 45: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/45.jpg)
Beyond documentation• Discovery and Documentation leads to suggestions
for improvement
• Where it makes sense replace custom scripts with commercially supported software and/or properly documented config management (e.g. Puppet or Chef)
• Exit plan and ethical Sysadmins / consultants
![Page 46: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/46.jpg)
• Bring sanity and clarity to all IT systems
• Living systems lead to better documentation
• Happy clients and happy people work well together
Conclusions
![Page 47: Documentation · Beyond documentation • Discovery and Documentation leads to suggestions for improvement • Where it makes sense replace custom scripts with commercially supported](https://reader033.fdocuments.in/reader033/viewer/2022060721/6081063e78332b45872914bc/html5/thumbnails/47.jpg)
More info:
• https://macvfx.wordpress.com
• https://github.com/macvfx/
• http://www.macdevops.ca