Levels of documentation

When thinking about documentation, it’s easy to go overboard with detail. The trick is to maintain the right balance of thoroughness and accessibility.

It starts with recognizing what documentation should not be. If you’re the owner of a piece of martech, you probably don’t need to be documenting every detail about how to use the application. That can be left for the user guides and docs the vendor themselves produce.

Your job instead is to document what’s different for your company. How a specific program works. The steps needed to execute this process. Link to the user guides of relevance, but focus on documenting the knowledge only you could know.

Too many people try to boil the ocean with their docs, and get overwhelmed doing it. Yet when you view this process as just the essentials, you may find documentation to be a lot lighter weight of a project than it first seems.