Starting a new job is always a ton of fun. You go through training, learn new stuff, and it’s always incredibly organized, right?

Right?

Okay, so maybe not. You open that legacy project and realize that you have no idea what the previous writer was thinking. The formatting is inconsistent. The standards are all over the place. And to make things worse, the other writers on your team are completely in the dark.

But what if it could be organized? What if you did know what the previous writer was thinking?

What if you had a Documentation Bible?

documentation-bible

What is a Documentation Bible?

Simply put, a Documentation Bible is a MadCap Flare project where you gather all of the information about how your team writes its documentation. It’s a collection of style guides, procedures, workflows, and more. More importantly, it is a reference guide for existing writers and a training tool—for both writing procedures and how your team uses Flare—for new writers.

Why Do I Need One?

Since you’re using a Documentation Bible to keep all of your procedures and style guides in one place, you don’t have to worry about having redundant information in multiple places. Because everything is written in Flare, it’s easy to review and update the material. And having all of your procedures written down will help you know what to do if someone leaves the organization—even if they’re just going on vacation for a couple of weeks and someone else has to fill in while they’re gone.

As a training tool, the Documentation Bible lets new writers work in Flare to edit existing procedure topics and create new ones. Having new writers edit existing topics means your Documentation Bible stays up-to-date, and having them write new ones means that it is forever growing and changing. Your writers learn procedures by writing about them, and frees you up for more important tasks. Plus, giving new writers hands-on experience in a sample project means that they have a chance to learn your procedures and voice before they go in and start working on your bigger, more complex documentation projects.

What Can I Do With It?

Anything you want! The Documentation Bible is your training and procedures playground. Create a style guide. Link to company documents using Global Project Linking. Add workflows for those complex processes you only use once a year (and never remember how to do again when you need them). Write down all the specifications for your printed outputs so the next time you need to create a page layout, you have them at your fingertips.

Who Can Use a Documentation Bible?

Everyone! If you’re a manager on a team, you can use the Documentation Bible to keep track of your team’s standards and procedures. When new writers start at your organization, the Doc Bible is a training ground where they can learn these procedures. If you’re a writer on a team, you can use it as a handy reference guide and an ever-growing knowledge base. And if you’re a lone wolf, the Documentation Bible is your right hand, keeping all the details and procedures for your project in one centralized location so you have a reference when you need it.

How Do I Benefit from It?

The Documentation Bible helps to bring your entire team onto the same page by keeping all of your procedures in one place. When you don’t have people wondering what the right procedure is, you save time and prevent errors. Since everything is kept in your authoring tool (Flare!), it is quick and easy to update. Plus, you can streamline your training processes by having writers learn Flare and your documentation procedures at the same time.

I’m Sold! What’s Next??

Great! If you’re ready to start working on your own Documentation Bible, check out my webinar on September 21st at 10 AM PDT. You’ll learn the kinds of things to include in your brand new Documentation Bible, I’ll lay out my four-step Documentation Bible training workflow, and I’ll even post a sample Flare project that you can use. I’ll see you there.

About The Author

Kate Schneider

About Kate Schneider

Kate Schneider is a Senior Technical Writer at MadCap Software. She has nine years of experience in the software industry, where she has background building online Help systems from the ground up, single-sourcing and restructuring complex documentation suites, and proposal writing. Kate enjoys spending time at the dog park with her husband and two West Highland White Terriers, playing video games, and watching Netflix. She holds an MS in Technical Communication from Northeastern University.

Last Modified: September 14, 2016

This entry was posted in MadCap Flare, Tips & Tricks and tagged . Bookmark the permalink.

Comments

  • Laura Cence September 21, 2016 at 11:18 AM

    Hi Kate — just got through with this webinar. Great job — one of the best I’ve seen/heard and totally worth my time even though I’m swamped and behind on my “real” work. Wondering when a recorded version of the webinar will be available — I’d like to have my teammates watch it. Thanks again!

    • Kate Schneider Kate Schneider September 21, 2016 at 11:29 AM

      Thanks Laura!! That’s so nice of you. The recorded version will be up shortly. I’m glad you enjoyed it and hope that it was a nice break from “real” work. (It was for me too…haha!)

  • geoffrey September 26, 2016 at 11:06 AM

    Hello Kate,
    Excellent Webinar. Really learned a lot. You’ve sold me! Working on a Doc Bible now. One question: Could I use (with a reference to credit you) your intro here about what a doc bible is and what the benefits of it are?
    I understand if you don’t want that. It’s very well-said though.
    Thanks.
    GM

    • Kate Schneider Kate Schneider September 28, 2016 at 11:32 AM

      Hi Geoffrey,
      Yes, absolutely! I’m glad you enjoyed the webinar. Let me know if you have any questions while putting together your Doc Bible. Good luck!
      Kate

Have Something to Say?

Your email address will not be published. Required fields are marked *