Writing sample (internal)

Installing the DITA production system

1 February 2016


  • Markdown
  • Task orientation

The documentation production system we use has many dependencies, and installing and configuring it is a long process. Our wiki contained bits and pieces of the tasks required to set up a development or production environment. I took those bits and pieces and test installed the system in various configurations so that I could create this single more cohesive set of instructions. This single document is used by both our development team and by outside IBM organizations that run their own installation of our system. Along with the instructions, I provided a few scripts to create and populate the database and to write some configuration files.

Link to sample: "Setting Up Vanguard for Production"
(sensitive information is blanked out)

Gary Faircloth

Interests: tech writing, programming, science, history. You might also find me playing some PC Ga—SQUIRREL!