Member You
#1 in Business Subscribe Email Print

You are here: Home > Computers and Technology > Software > Applying Web 2.0 to Technical Documentation

Tags

  • gather
  • community
  • processors
  • happens behind
  • technical communicationlets
  • internet companies

  • Links

  • Webcam And Online Dating
  • Automobile Insurance Is Necessary for Used Cars Too
  • Colon Cleansing - The Health Benefits of Cleaning Your Colon
  • Member You - Applying Web 2.0 to Technical Documentation

    Organic SEO - Great Return on your Marketing ROI
    Well, what I have long suspected seems to be true. Organic methods of search engine marketing simply must be taken seriously.What is organic SEO (I prefer SEM)? Well, while I have read many different versions, it is basically SEM, (search engine marketing) that utilizes SEO and submission tactics that are ‘by the rules’ or ‘white hat’ for natural listings (non paid listings). According to the Organic SEO Wiki, (http://www.organicseo.org/);“Organic SEO refers to the manual type of page optimization vs. automatic submittal and page alteration.” And “can be impl
    g it into the master document. Writers find themselves spending considerable time modifying the formatting and structure so that it conforms to the rest of the document. They rarely have the power to dictate the structure and formatting to others. Collaborative publishing means projects where documents are created by many different people working together (collaboratively) rather than individually.

    Web 2.0 offers a variety of ways to write collaboratively.

    These might:

  • be used as the principle authoring environment for documents.
  • be integrated into a unified documentation set.
  • sit alongside the "official" documentation
  • .

    The danger to technical communicators

    However, it may be like the early days of the Internet. Companies may decide to implement Web 2.0, and not involve technical communicators in the process. New job titles and roles within businesses may appear to describe people that do this type of work. Indeed, the delivered service may not be seen as online Help or even

    Retail Space Issues Solved by Wrapping Paper Storage
    With the winter holidays behind them, many retailers are left gearing up for spring and summer with rolls upon rolls of wrapping paper, and no place to put it. In-store wrapping is big business during the Christmas and Valentine’s Day shopping seasons, but retailers must find a way to store gift wrapping paper through the other three seasons of the year. Wrapping paper storage dispensers are one way to restore order and preserve paper for future use. They also help retailers organize and store paper for easy location and recovery.Wrapping paper dispensers are a great storage solution both in and out of the peak holiday season. They give retailers
    Introduction

    This article is based on my presentation at the Institute of Scientific and Technical Communicators' annual conference, in October 2006, on new trends in technical authoring. It covers the application of Web 2.0 technologies to technical documentation.

    The three waves of interestingness

    Every now and then, there are times where there is a change in the value of what a technical author delivers. These are moments when organisations pay attention to technical documentation. This is because they recognise these changes mean that they can create something that will be of real value to the business and to their customers.

    In recent years, there have been three "waves of interestingness". The first wave was the introduction of Windows Help (WinHelp). The second major wave was the introduction of the Internet and intranets. This was a time when organisations looked at how they could take large amounts of information and put them online. They were faced with issues such as how could users access and understand all this information easily - issues which technical communicators deal with on a day-to-day basis.

    I believe we're just about to approach the new wave, which we have called "Tech Writing 2.0".

    What do we mean by Tech Writing 2.0?

    Tech Writing 2.0 is application of Web 2.0 services and technologies to technical communication. Web 2.0 gives us the opportunity to significantly change the quality of what the users receive.

    This new wave is not about the introduction of DITA or the introduction of the new Help format in Windows Vista. These two technologies will mainly affect what happens behind the scenes. What the user receives is unlikely to change significantly from what they received today.

    What do we mean by Web 2.0?

    Wikipedia defines Web 2.0 as:

    "A second generation of services available on the World Wide Web that lets people collaborate and share information online. In contrast to the first generation, Web 2.0 gives users an experience closer to desktop applications than the traditional static Web pages."

    Web 2.0. (2006, July 13). In Wikipedia http://en.wikipedia.org/w/index.php?title=Web_2.0&oldid=63603254.(1997), The Free Encyclopedia. Retrieved 16:14, July 14, 2006.

    Within Wikipedia's definition, there are two themes:

  • Devolving content creation to the users (i.e. the collaboration on content creation and sharing of knowledge)
  • Providing a "rich user experience" (i.e. making Web applications feel more like desktop applications)
  • Another way of answering that question is to look at sites that people have called Web 2.0 sites. These include sites such as Lulu.com, Blogger.com, Flickr.com, Newsgator.com and Technorati.com. Within these we can see three common elements:

  • Collaboration on content creation
  • Conversation (wisdom of the crowds)
  • Aggregation of knowledge
  • How can we apply Web 2.0 to technical communication?

    Let's think about Web 2.0 could mean to technical writers. Not everything that comes under the banner of Web 2.0 impacts on the documentation world. Some of the techniques and technologies, however, can be used by technical authors to improve their documentation and the experience of those using it. It could allow you to:

  • Gain a greater understanding of the issues users face. You can involve your customers in development, gather intelligence and sustain a constant dialogue. You can promote conversations between members that build trusted relationships, self-help and support teams, bodies of knowledge, special interest groups to name just a few.
  • Provide better support. "The wisdom of the crowd" can emerge - the community members create new ideas and provide practical solutions for other members.
  • Sell "value added" support information for a fee.
  • Gain greater customer loyalty and trust.
  • Example - Collaboration

    Today, it can be very difficult to incorporate content from third parties. In most situations, writers have to resort to "cut and paste", taking content from one document and pasting it into the master document. Writers find themselves spending considerable time modifying the formatting and structure so that it conforms to the rest of the document. They rarely have the power to dictate the structure and formatting to others. Collaborative publishing means projects where documents are created by many different people working together (collaboratively) rather than individually.

    Web 2.0 offers a variety of ways to write collaboratively.

    These might:

  • be used as the principle authoring environment for documents.
  • be integrated into a unified documentation set.
  • sit alongside the "official" documentation
  • .

    The danger to technical communicators

    However, it may be like the early days of the Internet. Companies may decide to implement Web 2.0, and not involve technical communicators in the process. New job titles and roles within businesses may appear to describe people that do this type of work. Indeed, the delivered service may not be seen as online Help or even

    Avoiding a Boom Bust Cycle - What Top Companies Know to Do
    Company A likes bricks. In fact, they will wait for one to drop on their head before they make a decision. Then, in crisis mode, the big brass assembles the quaking troops and hands them limited ammunition to “see what they are made of.”Company A (s) marketing strategy is all war, too. Gear up, fire the cannons, work feverishly when the work comes in, suffer a slump when the work is done, downsize and upsize, but never “right size.” And, secret fears are circling that their entire market may be moving or downright disappearing.Company B, however, has embarked on a carefully conceived business plan that avoids Boom Bust Cycles. Here is what Com
    derstand all this information easily - issues which technical communicators deal with on a day-to-day basis.

    I believe we're just about to approach the new wave, which we have called "Tech Writing 2.0".

    What do we mean by Tech Writing 2.0?

    Tech Writing 2.0 is application of Web 2.0 services and technologies to technical communication. Web 2.0 gives us the opportunity to significantly change the quality of what the users receive.

    This new wave is not about the introduction of DITA or the introduction of the new Help format in Windows Vista. These two technologies will mainly affect what happens behind the scenes. What the user receives is unlikely to change significantly from what they received today.

    What do we mean by Web 2.0?

    Wikipedia defines Web 2.0 as:

    "A second generation of services available on the World Wide Web that lets people collaborate and share information online. In contrast to the first generation, Web 2.0 gives users an experience closer to desktop applications than the traditional static Web pages."

    Web 2.0. (2006, July 13). In Wikipedia http://en.wikipedia.org/w/index.php?title=Web_2.0&oldid=63603254.(1997), The Free Encyclopedia. Retrieved 16:14, July 14, 2006.

    Within Wikipedia's definition, there are two themes:

  • Devolving content creation to the users (i.e. the collaboration on content creation and sharing of knowledge)
  • Providing a "rich user experience" (i.e. making Web applications feel more like desktop applications)
  • Another way of answering that question is to look at sites that people have called Web 2.0 sites. These include sites such as Lulu.com, Blogger.com, Flickr.com, Newsgator.com and Technorati.com. Within these we can see three common elements:

  • Collaboration on content creation
  • Conversation (wisdom of the crowds)
  • Aggregation of knowledge
  • How can we apply Web 2.0 to technical communication?

    Let's think about Web 2.0 could mean to technical writers. Not everything that comes under the banner of Web 2.0 impacts on the documentation world. Some of the techniques and technologies, however, can be used by technical authors to improve their documentation and the experience of those using it. It could allow you to:

  • Gain a greater understanding of the issues users face. You can involve your customers in development, gather intelligence and sustain a constant dialogue. You can promote conversations between members that build trusted relationships, self-help and support teams, bodies of knowledge, special interest groups to name just a few.
  • Provide better support. "The wisdom of the crowd" can emerge - the community members create new ideas and provide practical solutions for other members.
  • Sell "value added" support information for a fee.
  • Gain greater customer loyalty and trust.
  • Example - Collaboration

    Today, it can be very difficult to incorporate content from third parties. In most situations, writers have to resort to "cut and paste", taking content from one document and pasting it into the master document. Writers find themselves spending considerable time modifying the formatting and structure so that it conforms to the rest of the document. They rarely have the power to dictate the structure and formatting to others. Collaborative publishing means projects where documents are created by many different people working together (collaboratively) rather than individually.

    Web 2.0 offers a variety of ways to write collaboratively.

    These might:

  • be used as the principle authoring environment for documents.
  • be integrated into a unified documentation set.
  • sit alongside the "official" documentation
  • .

    The danger to technical communicators

    However, it may be like the early days of the Internet. Companies may decide to implement Web 2.0, and not involve technical communicators in the process. New job titles and roles within businesses may appear to describe people that do this type of work. Indeed, the delivered service may not be seen as online Help or even

    Computers - How They Have Advanced
    Even over the last decade, the advances in computer technology have been immense. Computers can do more today than ever before, faster and at a better value price. Unfortunately, this also means that shopping for a computer can be confusing, as it is hard to know what you actually need and what is just an extra that’s nice to have. Hopefully this article can clear up a few of the mysteries for you.First of all, let’s look at processors. The two main companies producing processors today are Intel (Pentium processors) and AMD (Athlon processors). Although fanatics on each side swear otherwise, there is little difference between them, performance-wise.
    aditional static Web pages."

    Web 2.0. (2006, July 13). In Wikipedia http://en.wikipedia.org/w/index.php?title=Web_2.0&oldid=63603254.(1997), The Free Encyclopedia. Retrieved 16:14, July 14, 2006.

    Within Wikipedia's definition, there are two themes:

  • Devolving content creation to the users (i.e. the collaboration on content creation and sharing of knowledge)
  • Providing a "rich user experience" (i.e. making Web applications feel more like desktop applications)
  • Another way of answering that question is to look at sites that people have called Web 2.0 sites. These include sites such as Lulu.com, Blogger.com, Flickr.com, Newsgator.com and Technorati.com. Within these we can see three common elements:

  • Collaboration on content creation
  • Conversation (wisdom of the crowds)
  • Aggregation of knowledge
  • How can we apply Web 2.0 to technical communication?

    Let's think about Web 2.0 could mean to technical writers. Not everything that comes under the banner of Web 2.0 impacts on the documentation world. Some of the techniques and technologies, however, can be used by technical authors to improve their documentation and the experience of those using it. It could allow you to:

  • Gain a greater understanding of the issues users face. You can involve your customers in development, gather intelligence and sustain a constant dialogue. You can promote conversations between members that build trusted relationships, self-help and support teams, bodies of knowledge, special interest groups to name just a few.
  • Provide better support. "The wisdom of the crowd" can emerge - the community members create new ideas and provide practical solutions for other members.
  • Sell "value added" support information for a fee.
  • Gain greater customer loyalty and trust.
  • Example - Collaboration

    Today, it can be very difficult to incorporate content from third parties. In most situations, writers have to resort to "cut and paste", taking content from one document and pasting it into the master document. Writers find themselves spending considerable time modifying the formatting and structure so that it conforms to the rest of the document. They rarely have the power to dictate the structure and formatting to others. Collaborative publishing means projects where documents are created by many different people working together (collaboratively) rather than individually.

    Web 2.0 offers a variety of ways to write collaboratively.

    These might:

  • be used as the principle authoring environment for documents.
  • be integrated into a unified documentation set.
  • sit alongside the "official" documentation
  • .

    The danger to technical communicators

    However, it may be like the early days of the Internet. Companies may decide to implement Web 2.0, and not involve technical communicators in the process. New job titles and roles within businesses may appear to describe people that do this type of work. Indeed, the delivered service may not be seen as online Help or even

    Article Writing - How to Write a Fiction Article
    Writing a fiction article is a very interesting thing to do for those who have a natural aptitude of writing. The writers who write fictions are generally different from each other in their style. Same is the situation with the people who write fiction articles. Some of the people write a very well structured fiction article while their may be another person who has written an equally impressive fiction article but it may lack the strict boundaries of structure.Writing a fiction article is something people do in their own styles. If you want to write a good fiction article, you must jolt down the points or the themes which you want to discuss in your
    impacts on the documentation world. Some of the techniques and technologies, however, can be used by technical authors to improve their documentation and the experience of those using it. It could allow you to:

  • Gain a greater understanding of the issues users face. You can involve your customers in development, gather intelligence and sustain a constant dialogue. You can promote conversations between members that build trusted relationships, self-help and support teams, bodies of knowledge, special interest groups to name just a few.
  • Provide better support. "The wisdom of the crowd" can emerge - the community members create new ideas and provide practical solutions for other members.
  • Sell "value added" support information for a fee.
  • Gain greater customer loyalty and trust.
  • Example - Collaboration

    Today, it can be very difficult to incorporate content from third parties. In most situations, writers have to resort to "cut and paste", taking content from one document and pasting it into the master document. Writers find themselves spending considerable time modifying the formatting and structure so that it conforms to the rest of the document. They rarely have the power to dictate the structure and formatting to others. Collaborative publishing means projects where documents are created by many different people working together (collaboratively) rather than individually.

    Web 2.0 offers a variety of ways to write collaboratively.

    These might:

  • be used as the principle authoring environment for documents.
  • be integrated into a unified documentation set.
  • sit alongside the "official" documentation
  • .

    The danger to technical communicators

    However, it may be like the early days of the Internet. Companies may decide to implement Web 2.0, and not involve technical communicators in the process. New job titles and roles within businesses may appear to describe people that do this type of work. Indeed, the delivered service may not be seen as online Help or even

    Google Vs Yahoo - A Comparative Analysis
    As the search engine wars heat up between Yahoo and Google it's very interesting to note the similarities and differences between the two. Both companies are based in Silicon Valley with only 5 miles separating the two of them. Google has approximately 3,021 employees whereas Yahoo employs 7,600.Google was created in January 1996 whereas Yahoo is exactly two years older however Yahoo went public (IPO) on April 12, 1996 - Google's IPO wasn't until August 19,2004.FoundersYahoo was founded in January 1994 by David Filo and Jerry Yang who were both Ph.D. candidates at Stanford University. Google was founded exactly two years later
    g it into the master document. Writers find themselves spending considerable time modifying the formatting and structure so that it conforms to the rest of the document. They rarely have the power to dictate the structure and formatting to others. Collaborative publishing means projects where documents are created by many different people working together (collaboratively) rather than individually.

    Web 2.0 offers a variety of ways to write collaboratively.

    These might:

  • be used as the principle authoring environment for documents.
  • be integrated into a unified documentation set.
  • sit alongside the "official" documentation
  • .

    The danger to technical communicators

    However, it may be like the early days of the Internet. Companies may decide to implement Web 2.0, and not involve technical communicators in the process. New job titles and roles within businesses may appear to describe people that do this type of work. Indeed, the delivered service may not be seen as online Help or even user documentation.

    HTTP = HTML link (for blogs, profiles,phorums):
    <a href="http://www.memberyou.net/article/178846/memberyou-Applying-Web-20-to-Technical-Documentation.html">Applying Web 2.0 to Technical Documentation</a>

    BB link (for phorums):
    [url=http://www.memberyou.net/article/178846/memberyou-Applying-Web-20-to-Technical-Documentation.html]Applying Web 2.0 to Technical Documentation[/url]

    Related Articles:

    The Internet Angel

    Hav U Eva Saided or Writed Sumthin Uncorrectly?

    Understanding Rejection Slips

    Bookmark it: del.icio.us digg.com reddit.com netvouz.com google.com yahoo.com technorati.com furl.net bloglines.com socialdust.com ma.gnolia.com newsvine.com slashdot.org simpy.com shadows.com blinklist.com