Two documentation environments
My documentation work has evolved with the products and people it supports.
At Innovatia, supporting Avaya environments, I created a larger number of concise troubleshooting articles structured around symptom, cause, and resolution. They helped support staff move from an observed problem to a verified corrective action.
At StorMagic, the work has expanded into longer how-to and explanatory material. These articles often require more context: how a feature behaves, why a configuration matters, what to expect under different conditions, and how to complete a procedure reliably.
My approach
I begin with the reader’s actual task or uncertainty, verify the technical behaviour, identify assumptions and prerequisites, and structure the information so that key decisions are difficult to miss. The final wording must be technically accurate without assuming that every reader already holds the same context as the author.
What this demonstrates
- Adapting documentation to different products, audiences, and support models.
- Turning troubleshooting experience into reusable organizational knowledge.
- Writing concise symptom/cause/resolution guidance when speed matters.
- Developing detailed procedural and explanatory content for complex systems.
- Balancing precision, clarity, safety, and maintainability.
Knowledge that extends beyond an individual case, supports consistent troubleshooting, and gives customers and colleagues clearer paths through complex technical work.