I am currently documenting a command line interface that supports CRUD (Create, Read, Update, and Delete) operations for a variety of objects. As you can imagine, every object uses many of the same arguments. For example, when creating an object, the user can: Describe the object Activate the object Identify the type of data the … Continue reading Why conrefs are wonderful
Tag: technical writing
Four examples of Embedded Help. Do you offer this to your users?
If you have read my article, What IS it that you do?, then you might already know that one of my passions is helping my customers. One of the ways that I do this is by writing embedded help. Embedded help is user assistance that is integrated into the user interface so that users can get … Continue reading Four examples of Embedded Help. Do you offer this to your users?
What IS it that you do?
While working for a smaller company, fulfilling many roles, my title didn't matter, and it never changed. This didn't affect me until the company I worked for was acquired in 2014. The larger organization did a mapping by title, and I fell directly into the Information Development (ID) department. I was not happy. I had … Continue reading What IS it that you do?