Internal Docs

Internal Docs

I enjoy writing internal documentation because the tone can be less formal. This article had two goals: convincing my peers to use yet another MadCap tool and outlining how to set it up in our system (as opposed to outlining everything the tool offers).

Challenges

  • Encouraging progress without demanding it.
  • An audience of peers.
  • Balancing humor and professionalism.

Method

  • Provided pros and cons list for peers to make their own decision.
  • Included details specific to other products.
  • Used topics all products have in common in examples.

Tools

  • Sharepoint
  • SnagIt
  • MadCap Flare and MadCap Central