Wikis for documentation and product updates
Sunday, November 25th, 2007Anne 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.
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.
Bill Dranall is exploring the relationship between content management and information design in the Orange County STC (OCSTC) newsletter, TechniScribe. The current installment is on page 6 of the December, 2007 issue: http://www.ocstc.org/pdf/ts122007.pdf
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.
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:
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.
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.
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.
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:
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.
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:
Here is a summary of the resulting information gathered from this informal survey.
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.
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/.
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.
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.
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.
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.
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.
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.
A DITA collaboration solution is available for SharePoint 2007 Server, DITA Exchange. The DITA Exchange Product Fact Sheet is available: http://194.192.14.222/_layouts/dx/DxPublic/dx/DxFactSheet-2007-04.pdf
UC Davis has a web content management initiative, and did a survey on CMS use in universities. The project web site is at http://cms.ucdavis.edu/index.html
The University Web Developers mailing list (http://www.usask.ca/web_project/uwebd/) is reported to have discussions on use of content management systems.
The France Chapter newsletter arrives in summary form by email and the full version is published in a PDF file. Recent issues and interim announcements are listed: http://www.stcfrance.org/taxonomy/term/89 Right now, the current issue is at http://www.stcfrance.org/node/2405 There is an RSS feed, pulled in to Hyperviews Online to the right.
Technically Write has been revamped. The Summer 2007 issue is current at this writing and posted at http://www.stc-dfw.org/newsletter/current/editor.html In future months the link will be with the back issues.
The Summer 2007 issue has reviews of sessions at the recent annual conference, and features including one on using the web to enhance your job search (http://www.stc-dfw.org/newsletter/current/feature8.html).
Web Content Management - CM Pros Fall 2007 Summit. November 26, 2007, Boston, MA. http://www.cmprosevents.org
The focus is Web Content Management Technologies and Their Impact on the Way We Work. The Fall 2007 CM Pros Summit, takes place November 26, 2007 (in conjunction with the 4th Annual Gilbane Conference on Content Technologies Boston) at the Westin Copley Place. Early bird registrants save $100 on registration by September 30, 2007.
Web content management software has made it possible for organizations to increase workplace efficiency through collaboration, eliminate unnecessary waste through automation, lower cost of production through process improvements and workflow routing, and, perhaps most importantly, make possible the delivery of relevant content with pinpoint accuracy, increasingly, on demand. When localization and translation enter the equation, these benefits grow exponentially.
Where can organizations find the knowledge needed to take advantage of these powerful, paradigm-shifting technologies? The CM Pros Fall 2007 Summit is an excellent starting place. (more…)
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.”
If you’re in need of comprehensive information about today’s content management systems, try these sources:
http://www.cmswatch.com/Â (offering a report comparing nearly 30 systems, both open source and commercial enterprise systems)
http://www.opensourcecms.com/ (listing available systems)
http://www.cmsmatrix.org/matrix (providing comparisons)
Enterprise systems currently in use include:
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
The Scientific Communication SIG newsletter, The Exchange, is published in HTML in a new and old format and in PDF format. The newsletter is announced to members of the SIG each time it is posted. The summer 2007 issue is at http://www.stcsig.org/sc/newsletter/html/html2007-2.htm and http://www.stcsig.org/sc/newsletter/pdf/2007-2.pdf
In this issue, Geoff Hart reports on numerous sessions at the 2007 STC annual conference, and Jean Hollis Weber has an article on ethics in scientific and technical communication. There is a book review on writing in the health professions by past STC president David Armbruster.
Editor Geoff Hart was elected an STC Fellow in 2007. Congratulations, Geoff.