Archive for the ‘Tools’ Category

  1. Free MadCap Demos & Trainings

    December 16, 2010. No comments.

    If you are like me – addicted to MadCap’s products, or are just curious about the cool things these guys are developing, here is your chance to get free product demos, join training sessions, and get valuable tips on content development and working in collaboration from industry leaders at 2011 MadCap Roadshow in Long Beach, CA.

    madcap roadshow 2011

    The event coincides with Writers UA Conference (March 13th – March 16th). So if you are planning to attend the conference, do stop by at MadCap’s show. This full day event would cover various topics including authoring techniques, working in collaboration, content management, use of CSS, and guest presentations from technical communication experts in five sessions.

    Entry to the show is FREE, if you sign up now.

     
  2. Collect Feedback, Improve Content

    December 1, 2010. No comments.

    Collecting feedback and updating content is an important part of Document Development Life Cycle. However, it is a difficult bit too, especially when the content is distributed across multiple channels (online, print etc.). I will discuss various techniques for getting feedback and synchronizing documents later. Today, I am introducing Opineo, a free and open source tool for feedback collection. Publishers and writers can use Opineo to gauge quality of online content (such as articles, online help topics, tutorials, wiki pages etc.).

    Opnieo is available as a freeware and can be integrated with any website, blog, forum etc. It allows you to create and customize your feedback collection widget in a few minutes, and without having to sign up for an account or hire an expert. This DIY tool automatically generates code that you can download and paste in your page.

    Here is an example of feedback collection widget that I have created for myself.

    opineo for free feedback collection

     
  3. Writing Without Distraction

    November 16, 2010. No comments.

    As a writer, one of the major challenges I have to face, especially at workplace, is staying focused. It is really hard to concentrate myself on tasks when there is a lot of distracting things around – cell phones, banging doors, desktop clutter, email notifications and the temptation to see what people have to say and share at twitter and facebook.  I wished so much to have an attic room to go to and write without distractions. Fortunately, I can do that now without leaving my desk. I use WriteMonkey, a distraction free environment where I can write without distractions and stay away from pop-ups, notifications, and confusing toolbars.

    I have set up a 27” external display where I open WriteMonkey in full-screen mode and jot down my ideas, notes and draft documents. WriteMonkey is free and lightweight. It has a lot of awesome feature to offer, including:

    • Full-screen editing – hides all distractions from your computer
    • Portable – no installation required; just copy it on your computer or a portable device. It is just 1.5 MB is size.
    • Customization – fully customizable interface, layout, fonts, colors etc.
    • Keyboard support – all commands can be deployed with simple keyboard shortcuts.
    • Markup – Facility to markup text for formatting (*bold*, _italic_ etc.) and exporting to MS Word.
    • CSS-based Template – Use  your own templates to format documents for print
    • Timer – Facility to set timer to limit your writing to a certain time

    … and a lot more awesome features.

    free tool for writing without distraction

    Also check out these free tools for distraction-free writing:

    For tips on staying focused on your writing tasks, see Dustin Wax article on distraction free writing.

     
  4. Publish Print Friendly Documents Online

    November 10, 2010. No comments.

    Technical Writers, today, write for various forums (users community, wikis, knowledgebase portals, blogs etc.) and publish content in multiple formats (printable documents, XML, HTML etc.). When content is distributed across multiple forums and location, it becomes difficult to keep the text updated at all places. On the flip side, content available in different formats and at multiples places is readily accessible. You can easily refer to an online article, blog or forum. For a technical writer, this makes life easy especially if you are often asked to produce documents at the eleventh hour. There are a number of smart free tools that you can use to process online content into printable documents in almost no time. One smart tool is PrintFriendly.

    publish and print documents online

    PrintFriendly is a free online service that allows you to convert web pages into print  friendly documents with all margin and spacing matters taken care of. All you have to provide is URL of the page that contains desired content. It can be a blog post, an online web page, link to a discussion etc. Print Friendly processes the content and allows you to send the document directly to the printer or publish it as a PDF file that you can print later. Before printing, you can review and edit contents of the document. You can also use PrintFriendly to save online articles in PDF format for archiving purpose or to print and read later.

    printer friendly document publishing tool

     
  5. Working in the Cloud

    October 29, 2010. 3 comments.

    These days, I spend most of my time working in a cloud where I store most of my data and collaborate with my co-workers. More precisely, I work in a data cloud not ‘the cloud’, which is, accumulated mass of evaporated water :)

    If you are not familiar with data cloud, it is a space where all of your required software and services are running. You just need a personal computer and Internet connection to use these services – no additional hardware, software or IT infrastructure required. By using cloud-based services, you can do various tasks such as: creating and sharing office documents with your co-workers, use whiteboards, mind maps and many other tools to collaborate on different projects with your colleagues etc.

    cloud computing architecture

    Cloud computing has a lot to offer to writers and researchers who work in collaboration. There are a number of tools that writers and researchers can use to:

    • Create a virtual workspace where people from diverse locations can collaborate on a single project
    • Create, access and share documents from their virtual workspace in the cloud
    • Use almost all features for creating, formatting, editing and designing documents in multiple formats that most desktop applications offer

    Here is a quick round-up of some popular and useful tool for working on collaboration:

    Google Docs

    My foremost choice! Google Docs is simple, fast and free. Google Docs offer comprehensive set of features that you need to create, share and manage documents, spreadsheets, presentations, surveys, forms etc. You can also collaborate in real-time and track history of documents.

    Adobe Buzzword

    Robust and powerful tool for writing documents, reports, proposals etc. Buzzword also allows you to manage multiple versions of a document, collaborate with as many people as you want, edit images and view real-time updates from contributors.

    Advance users can use Adobe Buzzword with:

    adobe buzzword

    Microsoft Office Web Apps

    Free web-based version of Microsoft’s popular office applications. The suite includes Microsoft Word, Microsoft Excel, Microsoft PowerPoint and Microsoft OneNote. These services are available via Docs.com and SkyDrive.

    Writeboard

    Free collaboration tool by 37signals. Writeboard is complete free and can be used to create documents, track version history, and compare and rollback changes. Writeboard can be used in collaboration with Basecamp for an effective project management and collaboration experience.

    37 signals writeboard

    Gobby

    Free collaborative writing tool with many impressive features including:

    • Realtime Collaboration
    • Tracked Changes
    • Chat
    • Password protected sessions
    • Drag-and-drop environment for importing documents
    • Syntax highlighting for most programming languages

    Google Wave

    Since it is from Google, it is simple, free and fast. Google Wave can be used to organize web meetings and project collaboration. People are using Wave in creative ways in journalism, creative arts, education and many other industries.

    Zoho Writer

    Another free tool for online word processing. Zoho Writer comes with built-in templates, collaboration options, offline support and facility to import or export documents.

    ThinkFree

    Online services that provides free web-based office applications with 1 GB of online storage capacity. Documents created with ThinkFree can be accessed in smart phone built on Android, iPhone, and Windows Mobile.

    thinkfree online

     
  6. Favorites Forever

    October 20, 2010. No comments.

    Do you have hundreds of favorite websites bookmarked in your browser or piles of notes, documents, photos, ideas and emails saved in your personal computer? How do you filter and retrieve this information?

    I use Evernote to clip, tag and archive everything noteworthy – online articles, references, blog posts, tweets, mind maps etc. The data is synchronized with my online Evernote account allowing me to search my organized favorites anytime and anywhere. No more broken links (bookmarked pages that do not exist now), no lost files, and no pile of unorganized information.

    bookmarking with evernote
    If you are a technical writer and refer to bookmarked websites and topics frequently, use Evernote. It allows you to clip information, dump it in your Evernote notebook, and tag it with keywords for future reference. Dumping and retrieving data takes just 15 seconds. You can also use Evernote to save frequently used information so that it is easier to find and reuse contents when your are offline or away from your computer.

    Guy Kawasaki has suggested a number of ways to use Evernote and ease your life. I use it to:

    • Clip information – I save my favorite tweets, blog posts and articles in Evernote; this allows me to find and reuse contents easily.
    • Write and save notes in Evernote – No need to store papers or save text files and remember their names
    • Take picture notes – While on the go, I take pictures of anything noteworthy with my cell phone and then tag and dump photographs in Evernote.
    • Save Attachments – I forward email attachments to my Evernote account for safekeeping; because data in synchronized with my online account, I can access these files from any computer online.
    • Save Contacts – I do not carry piles of business cards. I photograph, tag and dump them. Evernote recognizes text so I sift through the data to find and save contacts later.

    Interesting? How would you use Evernote? May be you can use it as virtual whiteboard to collaborate with your team members, as ‘mood board’ to collect customer’s feedback or as personal gallery to store inspiring designs.

     
  7. The Terminology Cloud

    October 18, 2010. No comments.

    Technical Writers often have to use, explain or refer to terms in technical documents. Most technical documents contain glossary or a list of terms used in the document. Usually, tech writers in a company compile and share a list of commonly used terms related to their domain or business. This is a good idea! It ensures that all definitions are consistent across various documents, white papers, website content, and other communications by the company. Based on the same concept, TermWiki has compiled a huge list of terms that writers can consult in order to verify or find meanings of almost any term.

    termwiki

    The ever-growing list of terms at TermWiki is fed by a large number of contributors that provide definitions and translation of terms belonging to almost every industry including software, banking, sports, healthcare etc. Translations are available in English, Japanese, Russian, Korean and many other languages.

     
  8. Free and Open Source Content Management and Publishing Tool, Anthologize

    October 18, 2010. No comments.

    If you are a writer, researcher, digital artist or a publisher – you must have yearned for a simple and easy-to-use tool to compile and publish your work/research free and fast way. Now you can do it with Anthologize.

    Anthologize is a free and open source WordPress plug-in that you can use to gather content from multiple sources such as news feed, websites, your own blog, your published work etc. Anthologize also allows you to organize and format data and then publish it as a single volume in multiple formats such as PDF, eBook etc. All you need is a WordPress blog.

    free open source content publishing tool, Anthologize

    Anthologize can be used in many creative ways. For instance, you can use it to:

    • Create online portfolio
    • Manage galleries of your digital work
    • Manage collaborative work
    • Collect and display your online publications
    • Gather and organize your favorite articles, stories, poems etc.

    For details, visit Anthologize website at http://anthologize.org

     
  9. How to conduct a 5-seconds usability test?

    October 6, 2010. No comments.

    Are you an information designer or a technical writer experimenting with a new information portal, website design, technical illustration, product interface or a new layout of online help document? If yes, I suggest that you put yourself in the shoes of a novice user and test your design for its usability. Imagine how an average user would try to understand your new design.

    An easy way to analyze your design is to conduct a usability and memory test. Grab a screenshot of your new design/layout, show it to your friend (an average user) for a few seconds and then ask him what items he can recall. If your friend can understand the purpose of your design and recall core components, your design is successful.

    If you want to conduct a usability/memory test at large scale, try Clue. It creates online memory tests that you can share with your friends via facebook, twitter and email.

    It also lets you analyze test results to:

    • Understand how users interact with your online contents, data, or website design
    • Test how many people can find the ‘Buy Now’, ‘FAQs’, ‘Help’, or ‘Products’ links
    • Make sure that your product or website explains it purpose to average users
    • Get ideas for design improvements
    Creating a usability/memory test with Clue is simple and fast. Try it today!

     
  10. Are you ready for real-time collaborative writing?

    October 6, 2010. One comment.

    Though writing in collaboration with multiple teams and contributors has been in practice for quite some time now, but the tools and techniques for creating collaborative environment have started gaining popularity and wide-spread implementation recently. Technical Writers are now adopting this new paradigm and learning to work in virtual teams where people from multiple locations, different departments and various hierarchies can work together. This saves a lot of time and effort as compared to traditional writing, review and editing process.

    Google is one of the early providers of online collaborative writing services via Google Docs. The latest updates have made Google Docs a more convenient platform for collaborative writing. Now you can do a lot with your documents in an online, realtime environment from anywhere, anytime. The latest enhancements in Google Docs include:

    • Real-time collaborative highlighting in documents
    • Document translation
    • Auto-linking in documents
    • More page sizes
    • Add words to dictionary
    • Draggable rows and columns in document tables
    • Optical character recognition (OCR) to convert PDF or image to text
    • Themes, Improved Drawing Tools, Format Painter for spread sheets… and a lot more.

    If you are a technical writer and have not worked in collaborative writing environments yet, I suggest that you start exploring it today? Start with Google Docs; it is free!