"Hi, in my present organization, I solely work on the user manuals and before joining this organization I was in publication industry where I generally edited and rephrased the content for books and prepare the presentation (ppt) if required...... I…"
Technical Writing World
The social network for technical communicators
Karen Michele's Page
Latest Activity
Karen Michele commented on Karen Michele's blog post Writing Revision Notes"Thanks, Robin; I appreciate the info."
Robin Senor commented on Karen Michele's blog post Writing Revision Notes"your company should have a versioning standard that defines what numbered releases include features...check with your R&D manager."
Robin Senor commented on Karen Michele's blog post Writing Revision Notes"What I include in release/revision notes depends on the nature of the revision.
If the release includes features, I typically include what features are new, what issues are open, what issues have been closed since the last release, and any open…"
Karen Michele replied to Heidi A Slade's discussion What authoring tool do you use? Connect with your fellows."Hi, Heidi,
I use Frame for PDF-style docs and RH for help authoring. I'm happy with Frame but I abhore (sp?) RH. Our budget is tight right now or I'd be pushing for a new tool."
Karen Michele posted a blog postWriting Revision Notes
I need some practical advice on writing revision notes and document versioning. What information do you include in revision notes? Do you have any reference info on document versioning (vs. product versioning)? Thanks.See More
Karen Michele commented on Karen Michele's blog post Traditional tech docs vs. wikis, forums, and so on."I haven't heard of Eclipse. I'm still stuck with RoboHelp, which, IMHO, is awful."
Johannes Egenolf commented on Karen Michele's blog post Traditional tech docs vs. wikis, forums, and so on."Creating HTML help is what we are using our 'Scroll Eclipse Help Exporter' for. By doing that, we are able to author in Confluence and 'publish' to Eclipse help. Best of both worlds ;-) "
Sanjay G commented on Karen Michele's blog post Traditional tech docs vs. wikis, forums, and so on."I am into traditional documentation only ...writing User Guide, Installation Guide, and variety of other documents. In addition, i have created HTML help for our product using Eclipse."
Johannes Egenolf commented on Karen Michele's blog post Traditional tech docs vs. wikis, forums, and so on."You are welcome. If you need some further information or want to try some of our products, don't hesitate to contact us. Webinars are in preparation :-) "
Karen Michele commented on Karen Michele's blog post Traditional tech docs vs. wikis, forums, and so on."Interesting! Thanks for the reply. I've checked out your company site; looks like I could spend a little time there to learn more about using wikis along with traditional docs."
Johannes Egenolf commented on Karen Michele's blog post Traditional tech docs vs. wikis, forums, and so on."Hi Karen,we at K15t Software use our bleeding-edge wiki (plus our plugins) to create our 'traditional' documentation such as user guides, release notes and so on. In my opinion it is not necessarily a vs. relation but more a…"
Karen Michele replied to Stephan Quist's discussion Software Admonitions – International Standards vs Corporate Rules?"Hi, Mark,
Excellent point on "standards" sometimes being cooked up for profit, not utility. I can think of a number of examples from my own industry but shall not elaborate here. :) Thanks."
Karen Michele replied to Stephan Quist's discussion Software Admonitions – International Standards vs Corporate Rules?"Hi, Mark.
I had a thought on your post. You said these standards apply to product labeling, not technical documentation, but I've always thought of technical documentation as being specific to an industry, not an industry in itself. What I mean…"
Karen Michele replied to Stephan Quist's discussion Software Admonitions – International Standards vs Corporate Rules?"In Single Sourcing: Building Modular Documentation, author Kurt Ament says (in a nutshell), Notes are neutral or positive clarifications used in special cases; Tips are positive suggestions that help users apply something to their specific needs;…"
Profile Information
- How did you hear about TWW?
- I'd Rather Be Writing Blog
Karen Michele's Blog
Writing Revision Notes
Posted on January 11, 2012 at 3:23pm 3 Comments 0 Likes
I need some practical advice on writing revision notes and document versioning. What information do you include in revision notes? Do you have any reference info on document versioning (vs. product versioning)? Thanks.
Traditional tech docs vs. wikis, forums, and so on.
Posted on January 9, 2012 at 4:07pm 7 Comments 0 Likes
Greetings.
Another post got me curious: What percentage of your time do you spend writing "traditional" documentation--user guides, online help, quick-start guides, and so on--vs. more bleeding-edge stuff, such as social media, wikis, etc.?
Thanks for your feedback!
Comment Wall
- No comments yet!
© 2012 Created by Arnold Burian.
