Dilithium Networks
Posted on | October 9, 2009 | No Comments
Information Architect and Technical Publications Writer (March 2007 to May 2008)
I was hired at Dilithium to create a Command Line Interface reference guide for their DTG 3000 Multimedia Gateway product. As soon as I arrived, I realized the reference guide was the ONLY piece of documentation that they were creating for that product. What about the product description? Provisioning Guide? Ops & Maintenance? I tried to focus on the CLI reference.
However, when I write reference guides, I have a formula for good documentation. A description of each and every parameter a user can change. What is the purpose of the parameter? What are the values of that parameter? If you enter one value, how does that affect other parts of the system?
Regardless, because I am so systematic, I learn about all parts of a system. I learn how pieces fit together. I learn how to make it work.
I created outlines for the other documents in the suite. I created a reusable content strategy and a framework for the doc suite in Author IT. I trained three writers in India on the tool and how to think about creating reusable content. I used variables to reference product names and company names (one click and all appropriate references are updated). I created a provisioning manual and hyperlinked command command syntax to the reference guide to create a holistic user experience.
Later that year, I was hired to create the user experience and design a web user interface for this product.
Comments
Leave a Reply
Profiles
What I do
Current Projects
Past projects
Personal Projects
Search
Subscribe to blog updates
Corporate experience
