How do YOU document JAMF

Cayde-6
Valued Contributor

I've been tasked with the pain staking job of documenting JAMF, how each policy works, what are it's dependancies like Smart Groups, EAs, Packages etc.

I'm intrigued how others have done it and whether anyone would be willing to share a template perhaps?

Obviously we use Code commit which is fine for techies but I need to cater for non techies too.

74 REPLIES 74

Hugonaut
Valued Contributor

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.

________________
Looking for a Jamf Managed Service Provider? Look no further than Rocketman

rhooper
Contributor III

@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

mconners
Valued Contributor

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.

Cayde-6
Valued Contributor

@mconners I will take you up on that generous offer thank you very much.

mconners
Valued Contributor

Anytime @Cayde-6 if I can help in some way, I am glad to do so.

Hugonaut
Valued Contributor

@rhooper I use https://www.visme.co/ for the workflows

________________
Looking for a Jamf Managed Service Provider? Look no further than Rocketman

A_Eaton
New Contributor II

@mconners Any chance I could see that documentation as well? 🙂

CSCC-JS
Contributor II

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.

hdsreid
Contributor III

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

tlarkin
Honored Contributor

We use Lucid Charts, which is actually not bad for a SaaS diagram/document app

edickson
Contributor

Seems like you could become a "Jamf Professor" if you knew/documented all that it does. 🙂

Doctor of Jamf Studies maybe.

cwaldrip
Valued Contributor

I'd be interested in seeing some examples. How do you document things like individual smart groups or policies?

mconners
Valued Contributor

@A.Eaton if you would send me an email to mconners@madisoncollege.edu I would be happy to respond and send it your way.

ajith
New Contributor

Hi , Need some docs on the Jamf policies

 

tnielsen
Valued Contributor

Pencil and paper then take photo of the finished work.

atomczynski
Contributor III

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.

Tangentism
Contributor II

@mconners Could I tap you for an example as well please? Need to bring all our documentation up to date.

mconners
Valued Contributor

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.

A_Eaton
New Contributor II

@mconners That documentation is some of the best I have ever seen. Bravo!

mconners
Valued Contributor

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.

ematos
New Contributor II

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!

fneidhardt
New Contributor III

@mconners could I jump on this documentation bandwagon?

mickgrant
Contributor

@mconners could you please also share it with me

Sims_
Contributor

@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!

chrisandrews
New Contributor

@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

hurup
New Contributor II

@mconners Hey I would like to see this document too. I've sent you a mail. Thank you very much.

mconners
Valued Contributor

Hello @jgsims, @mickgrant, @fneidhardt and @ematos, if I missed someone else, my apologies. Just fire off an email to mconners@madisoncollege.edu if you already haven't done so. My entire goal in this documentation was to help others get into my thought processes. I am by no means an expert on all things Jamf, but what I have developed works really well for us. Sometimes, we can see the end results and revel in it, but to share with others on HOW or WHAT I was thinking can be enlightening.

As I have mentioned to others, empowering others to be empowered only strengthens our community as a whole.

I find it inspirational when my colleagues at our college in the Windows environment using SCCM are trying to figure out how I have done things so well with Jamf. Using Jamf has freed up some of my time and because of it, I have been afforded a luxury this summer to put all of this together.

If it is at all helpful, provides guidance or generally useful in any way, I am happy to share.

ematos
New Contributor II

@mconners I sent over an email to you. Again, thank you for your help on this. I appreciate the jamf community on empowering us with the knowledge to control our whole Mac fleet with all these different types of resources!

acekicker77
New Contributor

@mconners me too please 🙂 I'll send you over an email. Really appreciate it.

musat
Contributor II

@mconners, I also just sent off an email. You might want to set up an auto-reply rule based on some subject line. 🙂

mconners
Valued Contributor

Thanks @musat I have been getting a lot of responses. Quickly frankly, I have no problem helping people out. I don't have everything documented. Things like scripts and packages haven't been touched yet. I hope to round out things this winter in these terms. When I go to JNUC this year, I am meeting up with a couple of Jamf folks to get their ideas on how to tweak things. Thanks for the interest.

eric_fritts
New Contributor

@mconners I just sent you an email. I'll buy you a beer at JNUC this year!

PeterG
Contributor II

I have build an 'all encompassing' wiki for my Jamf Pro installation. I'll attach a few screenshots here.
The wiki documents (nearly) everything in and about jamf.

From architecture, setup, configuration, management and solutions. Content is documented and cross referenced when possible.

This wiki is open, in read only, to a wide group of people. There are a few restricted pages, with sensitive info.
Although this represents a significant effort it allows documentation to be linked and cross referenced. For example, A policy may have a couple scripts and a package in it and may have been initiated by a service request from SecOps. All aspects are documented. The Solutions section describes particular items that will be helpful when someone asks "How does that work?" "Why is that in there?", or the helpdesk techs want to know why an item doesn't show up for one user but does for another.

a7f01404019740e7998e2c13806f0f13

PeterG
Contributor II

Here is one detail page.
b7962129cc5f4e95b2b56644d1bdfbb9

gabester
Contributor III

@PeterG Hey I like what you've done there... but are you manually updating that beast or have you set some automation in place? To some extent as discussed in my team we feel that to some extent Jamf documents itself, however it requires too much digging in to find details and connections, there are some weird gaps. For example, why does a Policy not links to any scripts or packages used? One could use the API to extract a lot of that, and the explanation of the why, well, that's really the tough part of documentation isn't it?

Danko
New Contributor III

@mconners .. would appreciate to also get a copy of your documentation on danko@gmx.at.

Thank you in advance..

Best,
Danko

mconners
Valued Contributor

Hello @Danko thank you for your interest. I wasn't sure if that was your full email address or not. Feel free to drop me an email at mconners@madisoncollege.edu, thanks!

goebelamy
New Contributor II

I’m looking forward to seeing what everyone is talking about! Thanks for sharing your JAMF knowledge with all of us!!

PeterG
Contributor II

@Sterritt My documentation is all done manually. Documenting is integrated into the processes as jamf 'elements' are being created. I have found that if you 'intend to go back and document' you just don't do it so we do it inline with the jamf work itself. If you consider the external benefit that the Helpdesk staff, Security Operations or even the general public get from complete documentation, it becomes worth the effort. It also allows for documenting changes over time, to a package or policy.