In Brief, I create color coded flowcharts to present the deployment process. ie different colors for Package, Policy, Script, etc.
Policy contains said Package & Scripts. The flowchart details in which order they are deployed and where they are deployed to on the computer. I then use, in tandem with the flow chart, a text document containing the same information as the flowchart except it is all spelled out and highly detailed, includes the scripts in full as well as what the scripts do, the packages that are deployed & files contained in the package, where they go, what they do & why.
This is all compiled into a library of documentation. Looks great & Easily observed by both Technical & Non-Technical readers.
@Hugonaut What program do you use to make these color-coded flow charts?
I know there is io.draw available for free on the web which uses a ton of different icons and choices to choose from, but wanted your take on what you use.
Thanks,
R
Your timing @Cayde-6 is pretty incredible. I just finished documenting our basic workflow for os recovery. This entire document is very long but what I did was start with our automated workflow to either wipe and install a new OS on an existing computer or a new computer via DEP. I moved onto breaking this workflow down into specific policies and naming conventions to get this working. I then did the explaining of policies and each available payload along with the same for configuration profiles. Finally, to get all of our policies and profiles documented, as of today at least, I did a copy and paste from the JSS summary that would typically be sent to Jamf. I did explain our smart groups as well. If you'd like to see it, feel free to send me an email at mconners@madisoncollege.edu.
@mconners I will take you up on that generous offer thank you very much.
Anytime @Cayde-6 if I can help in some way, I am glad to do so.
@rhooper I use https://www.visme.co/ for the workflows
@mconners Any chance I could see that documentation as well? :-)
Microsoft OneNote(s) connected to OneDrive for Business.
One on "admin" configuration, contacts, deployment groups, etc
Another just on software, special configurations / required scripts, etc.
The one note is shared to other admins that could jump on in case I'm unavailable.
Unless there is something I am missing, Excel for Mac is extremely inadequate for serious data. But that doesn't seem to be the case on Windows if you have access to a VM or Windows box.
I give that preface, because I have been leveraging Excel to import data from the classic JSS API. Makes it easy to keep a "database" of all policies, config profiles, groups, computers that other admins have access to. It automatically updates every time it is open, and I have it on a sharepoint site as well. I have some legacy documentation on a OneNote notebook that I keep intending to update with these excel sheets as well
We use Lucid Charts, which is actually not bad for a SaaS diagram/document app
Seems like you could become a "Jamf Professor" if you knew/documented all that it does. :)
Doctor of Jamf Studies maybe.
I'd be interested in seeing some examples. How do you document things like individual smart groups or policies?
@A.Eaton if you would send me an email to mconners@madisoncollege.edu I would be happy to respond and send it your way.
Pencil and paper then take photo of the finished work.
The information @mconners is providing is of a very high standard.
I feel very fortunate to have found this thread. Creating documentation is one of my SMART goals for this year.
@mconners Could I tap you for an example as well please? Need to bring all our documentation up to date.
Hello @Tangentism I would be happy to share with you what I put together. Hopefully it can help in some way. Just fire off an email to mconners@madisoncollege.edu and I will reply with the two documents I have.
@mconners That documentation is some of the best I have ever seen. Bravo!
Thank you @A.Eaton and others for your kind words. Jamf has truly changed what I do and has allowed me the opportunity to document my workflow and share with others. If any of it provides guidance or inspiration, I am more than happy to share.
Hey @mconners do you mind sharing that with me as well? This thread has inspired me to get some type of Documentation going at my organization since I have been tasked to become the Jamf master here lol. Would much appreciate what you have so I can get some ideas!
@mconners could I jump on this documentation bandwagon?
@mconners could you please also share it with me
@mconners May I too get a share of your documentation? I just discussed documenting Jamf with my boss the other day and then I find this thread, what luck!
@mconners I’ve been needing to document the system for a while now. If I can see yours it might give me somewhere to begin!! I’ll send an email shortly. Thanks
@mconners Hey I would like to see this document too. I've sent you a mail. Thank you very much.