Hyperviews Online

Anne Gentle has provided a list of wikis she has found that are used for product documentation or to provide new and updates about software products.

by Anne Gentle

Is your webmaster feeling the pressure of being the single point of contact for website updates? Do your members go to the website looking for answers to a few simple questions only to find archived PDF newsletters from the early 2000s? Even if you answered no to both of these questions, a website design with a collaboration-enabled content management system can help you serve local members and also share the tasks of writing new and updating current content.

Fortunately, there are web content management systems available to webmasters to help effectively manage a local STC website when your members’ expectations for a website are reaching new heights every year. This article shares the research that a small team did while working on a redesign of the STC Austin web site in the summer of 2007.

Design priorities

Before discussing the technology, be sure that you have studied the needs that your website meets. In our case, we wanted to address three items as priorities:

• Posting jobs and resumes
• Updating meeting and event information
• Sharing contact information for the officers

We looked at our logs and statistics for the web site (knowing full well that web stats are an inexact science) and backed up our priorities with statistics analysis. The only additional detail we found was that site visitors read a salary survey report and a listing of technical publications agencies quite often so we knew those had to be included going forward. We made our top priority providing continually updating information for job seekers.

Budgeting for website needs

We also had our past year’s budgets available and also looked for areas where website features could save money in others’ budgets. An example is the annual local salary survey we conduct, which cost the chapter $120 a year in the past. If a web-based survey could save some money in that area, we wanted to be sure to try to design that into the site. Part of analyzing the budget was looking at the amount of bandwidth necessary to ensure the same level of service to the web site visitors.

Researching CMS technology

Next I sat down and looked through more than a dozen local STC community sites to look for trends and observe designs that I liked and found useful.

Based on reading http://stcforum.org/viewtopic.php?id=117 and http://stcforum.org/viewtopic.php?id=785 plus doing some investigation of other chapter’s websites on my own, I gathered that other chapters have used these CMSes.

• North Carolina STC at http://www.stc-carolina.org uses Tiki Wiki from http://tikiwiki.org/
• Indiana STC at http://www.stc-indiana.org/ uses Expression Engine from http://www.pmachine.com/
• Iowa STC at http://stc-desmoines.org uses Plone from http://www.plone.org
• STC France at http://www.stcfrance.org/ uses Drupal from http://www.drupal.org

I noticed that many local communities have started using WordPress from http://wordpress.org for their website. While WordPress is typically associated with blogging software, it is also a decent CMS. Posts are typically displayed in journal fashion with the time/date stamp dictating the display, but WordPress also has page management and plug-ins that let you use it in a CMS manner. The WordPress sites that caught my eye are:

• Hyperviews Online (this site)
• http://www.stc-suncoast.org/
• http://www.stcalaska.org/

Having used WordPress for my blog at www.justwriteclick.com and thinking it would work well for multiple contributors on a geographic community web site such as STC Austin, I decided to focus my attention on the how and why of a WordPress implementation. My basic knowledge of WordPress was that there’s a wordpress.org, where you download and install your own installation of WordPress and any plugins you need, and there’s wordpress.com, where you can set up a blog quickly but you cannot install plugins.

Surveying web masters who use WordPress

Armed with my tiny bit of knowledge about WordPress (the .com variety, not .org), I emailed the web masters for the WordPress sites and asked them the following questions:

1. Did you set it up as a group blog so that officers can write and publish their own pages?
2. Is it a hassle to manage permissions for users?
3. Do you need certain WordPress plugins (thereby not allowing us to use hosted WordPress at wordpress.com)
4. What do you accomplish with the plugins?
5. What’s the most difficult thing to accomplish with Wordpress for your current website goals?
6. What areas or functionality do you feel are lacking?
7. How much involvement do you have with multiple content editors?
8. How difficult was it to train others to use WordPress?
9. Can you outline the general design you took when starting out with WordPress? What have you added on later?
10. What other CMSes were on your radar?

Here is a summary of the resulting information gathered from this informal survey.

Group blogging and managing permissions for users

Everyone had set up their WordPress site as a group blog, and said that permissions are quite easy with WordPress. People described two basic approaches. One is to have one or two editors who are the only ones given permission to publish content. The second approach is to give everyone that contributes content the ability to publish that content. One downside to the first approach that a site administrator noted is the lack of an email notification so that contributions being saved would automatically trigger an email notification to the person with publishing permissions. There’s a WordPress plugin for that, but in their particular case, it would have required an update of the underlying WordPress software to use a compatible plug-in.

To others, the difficulty in the second approach (allowing everyone to publish) mostly centers on getting enthusiastic and consistent contributors.

WordPress plugins

Tom Johnson gave a very helpful list of WordPress plugins that he uses for the http://www.stc-suncoast.org/ site.

Examples of uses for WordPress plugins are tasks like spam control, displaying event calendars, and RSS feed management. I’ve included links to each of the plugins’ sites for easier viewing and downloading.

Spam control: Bad Behavior, Akismet, and Spam Karma (”Activate all 3 and spam disappears,” says Tom.)

Show inbound links to your web site: Kramer

Protect email addresses from spam: Obfuscate Email

Show most popular posts: Popularity Contest

Show related posts: Related Posts

Ease of configuring sidebars: Samarsin PHP widget

Show people who have commented the most: Show top commentators

Show advanced toolbar for editing content: Visualize Advanced Features,

RSS feed management: Subscribe to comments

Basic and overall site administration: WordPress database backup, All-in-one SEO pack

Multimedia: Podpress, Video plugin

Events and calendars: Event calendar and widget, Evermore

Content management: List subpages, Table of contents generator, and WP-table

For a list of all the Wordpress plugins, go to: http://wordpress.org/extend/plugins/.

What was most difficult to accomplish with WordPress?

Even backup is easy with WordPress, so most major administrative tasks are not difficult. Listservs are typically separate from the web site, so the disconnect between an email-based system and an RSS or blog-notification system is apparent, and you do not know which one ensures that everyone in the chapter gets certain postings or notifications. So it is not easy to push notifications using WordPress alone.

Functions that WordPress lacks and managing multiple contributors

Some web masters found that member participation is the most difficult to accomplish but know that is not related to the Wordpress tool. However, participation is critical to the success of a content management system if you want the content to be contributed by everyone. So your community culture is a factor in setting up a CMS-based web site if you want other officers or members to contribute content.

Training others to use WordPress

No training was needed for the editor and content addition tools, other than ensuring that authors do not paste in existing “bad” HTML code such as that generated by Word. A training session sounded like a good idea although no one had held one yet.

For the SunCoast community, job opportunities are the most frequently posted items, and the employment manager posts those, so it was important to insure that the other officers are ready and willing to use WordPress to post new opportunities.

General website design tips

Ann Wiley had the good advice to “Use the default, because it’s closest to the Xerox Publishing Standards and the least work to use for multiple sites. When designing your STC community website, include the required and recommended items in the STC Newsletter Competition guidelines.” You could use those guidelines for your outline if you were stumped for other ideas.

CMS choices besides WordPress

As the list above shows, many other STC communities are using other CMSes such as Drupal, Plone, Tiki Wiki, Expression Engine, and Joomla. Destry Wion, a web designer at http://wion.com, wrote about selecting an open source CMS at Hyperviews Online that also serves as a good reference.

Merging design and content management to meet your goals

By keeping your members goals in mind, you can ensure that your website has current updated content that is managed and backed up and contributed by many instead of a few using WordPress or another content management system. While we eventually selected Joomla as our CMS for our new (unfinished) site at www.stc-austin.org, the research I did for WordPress implementations should be helpful to anyone beginning to consider using a CMS for maintaining their STC community website.

Scott Jehl (http://www.scottjehl.com) has posted a free web-based tool for creating sitemaps, http://writemaps.com/  ”to provide a fast, fun, and easy way to plan your websites.”

The ITBusiness site has published “Wiki Implementation Challenging, Not Overwhelming” (http://www.itbusinessedge.com/item/?ci=31546&sr=1) Novell IT manager Lee Romero reports on use of Wikis by engineering and enterprise-wide. An engineering Wiki runs on Twiki, chosen because it provides access control for pieces of content.

Romero advises conducing a pilot test when implementing a Wiki, attention to needed security, and plenty of time for training and acclimating employees to the technology. Typical releuctance to embrace new tools caan impeded adoption even though Wiki software is easy to use.

A new and (the authors hope) extremely useful set of accessibility prinicples and checkpoints is now available for download: http://www.mscui.net/DesignGuide/AccessibilityPrinciples.aspx and http://www.mscui.net/DesignGuide/AccessibilityChecklist.aspx

These documents were produced as part of the NHS Common User Interface program, a collaboration between England’s National Health Service (NHS) and Microsoft. The goal is to create design standards for point-of-care IT systems used by doctors, nurses and other health professionals.

This work focuses on complex clinical IT systems, and is drawn from analysis of eight industry-standard accessibility standards, including W3C, ISO and the US Access Board. The work is intended to be applicable to any rich application. Jon Dodd ( http://www.bunnyfoot.com/about/people.html) is the primary author – this work would not have been possible without his experience and expertise in the field. The NHS CUI seeks feedback in order to improve the guidance and thence the accessibility of IT applications within the NHS (the UK’s largest employer). Please direct comments to: cuistakeholder.mailbox@nhs.net

Online SIG Education Lead Tom Johnson has published articles on using WordPress as a CMS and providing other tips too.

Tom explains WordPress plugins here: http://www.idratherbewriting.com/2007/04/17/wordpress-plugins-extending-your-blogs-features-and-capabilities/

Tom’s post on how to use WordPress as a CMS is published at http://www.idratherbewriting.com/2007/07/01/converting-your-wordpress-blog-into-a-cms-content-management-system/

Tom gave a presentation on WordPress that is posted here: http://www.idratherbewriting.com/doctrain

In a message to STC leaders who use WordPress for chapter and SIG sites, Tom also recommends the WordPres podcast: http://wordpresspodcast.org

Whether it’s accurate to say that just a few people write Wikipedia, or a large number of people do, depends on the kind of analysis that’s done: http://www.aaronsw.com/weblog/whowriteswikipedia

A “Web Trend Map for 2007″ has been posted and is reported at http://www.techcrunch.com/2007/07/20/information-architects-2007-web-trend-map/

The map depicts the 200 “most successful” websites on the Internet, shown by category, proximity, success, popularity and perspective. The map is meant to show the relationship among sites, and the focus is on Web 2.0.

The Web Trend Map is based on the Tokyo metro subway map. Posters are available and there is a PDF for download.

Flock (http://flock.com) is a social browser, built on Firefox with all of the Firefox extensions. A bookmark in Flock is instantly mirrored on Del.icio.us. Photos and blogs dragged to Flock are uploaded to Flickr or Photo Bucket. It’s not necessary to log into a blog such as WordPress or Moveable Type to blog text that is selected from a web page; Flock does the blogging.

The founder of Wikipedia has launched a service offering free tools for community websites, it was reported in the BBC news December 12, 2006.

Online SIG Education Lead Tom Johnson is aggregating podcasts on the STC Suncoast Chapter site: http://www.stc-suncoast.org/podcastfeed Included are many podcasts by technical communicators, and podcasts from the Four Lakes chatper of STC.

by Guy Ball, Senior STC member, Orange County (CA) Chapter
Reprinted from the December 2006 issue of TechniScribe. If you reprint this in your publication, please send a PDF copy or link to the author.

While text is still best for presenting many types of reference and procedural information, video can be very effective when illustrating product features, clarifying system configurations, and supplementing complex written procedures. The trick is to merge the two so they complement each other and deliver a dynamic documentation package as either an online or CD-based “Web seminar.”

Although the multimedia concept has been around for some time, creating a seminar like this traditionally requires a good-sized team of writers, videographers, graphic artists, subject matter experts (SME), and a manager, to keep the team working smoothly. If you already have a large staff or access to graphic professionals, congratulations!

Our staffing situation is totally the opposite. We have to make do with a single writer and a few subject matter experts (SMEs). The plus of this situation is that it allows us to deliver the final product faster and less expensively—both important considerations for our cost-conscious management.

We take advantage of our low-cost (but high-quality) video camera and simplified video-editing software to deliver additional “visual documentation” to our service support team and customers. For us the trick is to look “clean” and professional while not getting caught producing a Hollywood extravaganza that would demand tons of staff time and weeks of extra work with little extra benefit. Instead of “fancy,” we make sure our content and delivery is effective both from communications and cost perspectives. (more…)

These sites continually publish news about online communication:

http://arstechnica.com/
http://www.basement.org
http://www.thinkvitamin.com
http://www.digital-web.com
http://www.techcrunch.com
http://looksgoodworkswell.blogspot.com/
http://radar.oreilly.com/
http://www.readwriteweb.com/
http://blogs.zdnet.com/web2explorer/
http://blog.webreakstuff.com/
http://ajaxian.com
http://blog.wired.com/monkeybites/
http://digg.com/view/technology
http://www.37signals.com/svn/
http://www.joelonsoftware.com/
http://www.informit.com

More are listed in this earlier post.

An overview of XHTML for mobile devices is available: http://www.littlespringsdesign.com/design/xhtmlinfo/ The site has a variety of other resources on mobile devices also,

Nokia is working on augmented reality, the subject of an earlier post on “digital grafitti.” Nokia is demonstrating a system that allows a phone to sense its location and the orientation of its camera, and then pull information about the visible objects from a database: http://www.technologyreview.com/BizTech/17807/