Appropriate Content: Informix Documentation Team
Matching: ids X
Want to hear about news, events, and other fun stuff about Informix? Like IBM Informix Dynamic Server (IDS) on facebook.
You might have noticed the complete lack of social niceties like "please" in Informix documentation. Occasionally, I do get messages to review from developers that say things like "Please read the Guide to SQL: Syntax for information on the syntax." Or even better: "Please contact IBM Software Support." I have to take out the "please" because it is against IBM style guidelines.
The official IBM Style guideline on "please" instructs us not to use "please" in IBM technical information: Terms of politeness are superfluous, convey the wrong tone for technical material, and are not regarded the same way in all cultures.
In some cultures, when you use a word like "please," it indicates that the action mentioned is optional. We have to take into account that our documentation will be translated and also that it will be read in English by people whose first language is not English.
So you see, we are not being rude--just authoritative!
The new Informix Products information center has all the documentation for older Informix server and CSDK versions, 4GL, DataBlade modules, and other tools.
Instead of clicking around over 2000 Pubs Library web pages, you can now find all the titles on one site!
To find the title you are looking for, just enter it in the search box in the upper left-hand corner and click Go.
These URLs are now redirected to the new information center:
If you have any feedback on the new information center, please let us know!
This post is from Howard Glaser, the Informix usability expert. He attended the IIUG conference last week.
I want to thank all of the 2010 IIUG Conference attendees who provided feedback in our Usability Sandbox and customer sessions at the conference. Your feedback is invaluable in making IDS even better! Below is a list of the usability sessions that were held at the conference. Let us know if there are additional usability topic areas that you would like to see at future conferences (please write to firstname.lastname@example.org).
• Hands on experience test driving the latest Schema and Storage Manager UIs for the OpenAdmin Tool
• A sneak peak and feedback on the new IDS Installation and Configuration Tooling/UI: A group walkthrough discussion with the IDS Dev team
• A sneak peak and feedback on the new IDS Deployment Tooling/UI: A group walkthrough discussion with the IDS Dev team
• Your opportunity to give your input on useful sources and resources for solving problems encountered while using IDS: An examination of current and future resources followed by a group exercise to provide your preferences
• How Optim may be used for problem determination and resolution with IDS: A walkthrough and group discussion
About a year ago, we decided to try something different for certain kinds of information: quick reference cards. They are designed to be printed out on a single piece of paper, both sides. We currently have two quick reference cards, both of which represent 11.50.xC6 information: one for onstat commands and one for the onconfig.std. When we originally published them, they were 8.5"x11" size, but since then there were a few additions to onstat and onconfig.std, so now they are both legal sized.
onstat quick reference card
onconfig.std quick reference card
We are hoping to create other quick reference cards this year, but we need your help! Let us know what you'd like to see. Here are some possibilities:
Here are some tips for using the IDS info centers.
To search a particular topic or a set of topics in the 11.50 info center:
1. Select the topic in the left-hand side navigation tree.
2. Click Search Topics on the toolbar above the navigation pane.
3. Choose Search this topic or Search this topic and all subtopics. A search dialog box appears.
4. Enter your query in the Search field, and click OK.
Note that the procedure for doing this in the v10.0 or v11.10 info center is a bit different; you select the topic and then click the arrow next to the topic title.
You might have noticed that no matter where you go in the info center, the URL stays the same. Each topic, however, does have a unique URL. To copy the URL of a particular topic, select the topic title in the navigation tree, right-click it, and choose Copy Shortcut or Copy Link Location. Topics that come from books also have the URL at the very bottom of the topic.
Subscribing to information center updates
You can subscribe to the IDS information center RSS feed to stay up-to-date with the latest updates in the information center. You can add this feed to your preferred RSS reader. When the information center is updated, you will receive a notification in your selected RSS reader with a link to the updated content. Looks for the RSS link on the information center home page.
Improving your search results
Use the following techniques to improve the search results that are returned:
· Search for exact words or phrases by using double quotation marks. For example, if you enter "log file" in the Search field, you search for all occurrences of the string log file. Without the double quotation marks, the search returns topics that contain instances of both the word log and the word file.
· Use wild card characters, such as the asterisk (*) and question mark (?):
o Use an asterisk (*) for multiple unknown or variable characters in the search query. For example, if you enter par*, the search returns topics that contain partly, participate, partial, and other words that begin with par.
o Use a question mark for a single character in the search query. For example, if you enter par?, the search returns topics that contain part, but not partial or partly.
· Use Boolean operators AND, OR, and NOT to make your search more specific:
database AND "log file"
Narrows the search to return any topics that contain both the term database and the phrase log file.
database OR "log file"
Widens the search to return topics that contain either the term database or the phrase log file.
database NOT "log file"
Narrows the search to return any topics that contain database and that do not contain the phrase log file.
database OR "data base" NOT "log file"
Searches for topics that contain either the term database or the phrase data base and that do not contain the phrase log file.
We are very excited about our new blog, as it gives us a way to let you know what's on our minds, share info that might find useful, and give you a chance to post your own comments and thoughts on the Informix documentation. Let us know where you'd like to see us go next with the product information, or just visit regularly and learn more about the things that keep the information developers awake at night!
We work hard on delivering what we think you, our customers, need in product information (which includes but is not limited to the product documentation that you see in our information centers and PDFs). We know that there's no shortage of things we can be working on, whether it's new documentation about the latest features, improvements to existing documentation, or new info resources like our onstat or onconfig Quick Reference Cards. So anytime we can get some direction and feedback from you, it makes a big difference in how we decide on what we do, and how we do it.
Here's the Informix Documentation Team:
I've been writing Informix documentation since 1996 (aka "the good old days"). I work on DataBlade module, Enterprise Replication, and embeddability documentation. I used to be the team lead of the Informix doc team and work on release notes, but (thank goodness) I'm only the technical lead now. Being the technical lead means, among other things, that I'm supposed to know the IDS doc set inside and out. I can honestly say I know the outside really well. I'm also the moderator for the 11.50 information center, so if you leave a comment, you might hear from me! My hobbies include driving my kids around and making up words I'm not allowed to use in Informix doc.
Hai-Nhu Tran (pronounced like the movie High Noon, but without the N at the end)
I'm the newly minted manager of the Informix Information Development team. I started at IBM in 2000, joined the Informix ID team as the Team Lead in 2007, and earlier this year I had the good fortune of becoming the manager of this dedicated group. I studied English literature in college and never would have guessed that I'd end up in software documentation! I'm currently working on instilling a life-long love of books in my 3 year old daughter, and so far I've been 100% successful. When I'm not reading Dr. Suess, I'm working through my own book list (which happens to occasionally include children's books, oddly enough), sampling the seemingly endless supply of restaurants and farmers' markets in San Francisco, and dreaming of being able to sleep in again at some point in my life.
Bill Belisle (pronounced: bell-eye-L)
People have been mis-pronouncing my name at IBM since June of 2006. I concentrate on writing about Informix high-availability (sometimes known as MACH-11) features. I’m also responsible for the Informix Administrator’s Guide, the Backup and Restore Guide, virtual appliance, and cloud documentation. I have a degree in journalism from Boston University and have written several college-level textbooks on Lotus 1-2-3 and Microsoft Office and Excel. My hobbies include (in no particular order): astronomy, machining and metalworking, woodworking, CNC, photography, reading, seismology, and high-vacuum thin-film deposition.
I’ve also been writing Informix documentation since 1996, initially specializing in online help. Currently, I’m concentrating on updates to the Migration and Performance Guides and on new feature documentation (such as compression). In the past, I’ve worked on the Common Criteria certification guide, the Administrator guides, and MTK documentation.
Karin Moore (pronounced car-in)
I've been on the Informix documentation team since 1996, and am currently the infrastructure lead. What that means is that I create, update, and deliver the information centers, documentation CDs, and techdocs. I also manage source file control, automated builds of the documentation sets, and translation. It's a nice variety of work that lets me dabble in all the Informix products. My hobbies include birdwatching, hiking, gardening, and caring for injured animals at a local wildlife rehabilitation center.
Johanna Turaj (pronounced tour-eye)
I joined the documentation team in February of this year. Though I’ve been doing Information Development since 19<mumble>, I’m the new kid on the Informix block. In my role as Team Lead for IDS, 4GL, and some other acronyms, I get to learn about all the products and develop plans to help the team deliver helpful information you need when you need it. I enjoy travel, knitting, and keeping my cats off the keyboard.
I'm the technical editor for the Informix writing team. I work with the writers to produce the best possible documentation for our customers. I'm not an expert in the technology we write about (that's my team's job), but I'm familiar with the technology and terminology, and I review the documentation to ensure that it tells customers what they need to know as accurately, concisely, and clearly as possible in a consistent manner. Rest assured, I won't be editing this blog (phew!) so the writers will get to express themselves in their own "voice". Oh, and my name is pronounced as it's spelled (http://www.medjugorje.org/croatianlanguage.htm).
Information development is my "second" career. I launched my career in book publishing production and project management--a good foundation for handling a lot of the behind-the-scenes work in creating technical documentation. During the Sturm-und-Drang of the dot-com era, I gained experience documenting database migration and a few end-user applications. Along the way, I earned a B.A. degree at Oberlin College and a Technical Writing Certificate at San Francisco State University. I speak German as a second language, and have a beginner/intermediate knowledge of Spanish.
Hi! My path to technical writing was the "road less travelled". I graduated with a degree in Economics and went to work for the Defense Intelligence Agency in Washington DC. Through various twists and turns there I moved into courseware development and teaching computer applications, which eventually lead me to IBM about 10 years ago where I have worked on Informix and DB2. With the Informix team I work on a wide range of documentation from the Administrator's Reference and SQL Reference to the Common Client information. Most recently I have been working on improving our warehousing documentation.
Tom Houston (pronounced the opposite of the similarly-spelled street in Manhattan)
I was employee #237 when Informix was still called "RDS Software" in Menlo Park, California, and I have been monitoring the Informix Technical Publications external email alias since it was called "email@example.com" (but it is now spelled "firstname.lastname@example.org"). I mostly work on the IBM Informix Guide to SQL: Syntax, which keeps me busy documenting new SQL features and correcting the errata that I create while documenting new SQL features (or while correcting older errata). Among my hobbies are photography, dreaming, and trying to outwit spelling-checker software.
I've been with IBM Informix since 2008. I write the UI text and help for OAT. I once wrote longer sentences.
I'm not officially a member of the Informix Documentation Team. I've been responsible for usability and user interface design on Informix products since 2006 and am heavily involved in the UI design of OAT. I am a professionally trained Human Factors Engineer/Psychologist and have been working in the human computer interaction and design field for more than 25 years.
I'm currently a remote co-op or supplemental employee on the Informix ID team working in Socorro, NM. I have been with the Informix team since 2008 and have worked both full- and part-time. A majority of my tasks deal with DITA markup such as migrating books from SGML to DITA. Recently, I have begun to work with development teams in India to produce documentation for the 4GL and CSDK components of IDS. I am responsible for all documentation with in 4GL and CSDK. I'm currently pursuing a degree in Technical Communication from the New Mexico Institute of Mining and Technology.