Technical Writing Quote of the MomentNo person who is enthusiastic about his work has anything to fear from life. Who's onlineThere are currently 0 users and 40 guests online.
Latest Classified Ad |
Interesting and Relevant SitesCures for the Information Exclusion ComplexSome years ago, I used to suffer from developer neglect, or to use a more scientific term, from a kind of information exclusion complex. You know what I’m talking about. Developers make updates to the interface, often at the last minute, and don’t let the tech writer know what changed. As a result, the help is wrong and out of date. It’s a frustrating experience from the writer’s perspective. Information exclusion is fairly common. Just last week I learned about an application that had a new version nearing release in a week, but the developers hadn’t told me about it. I documented the previous version, and although the developers made the help button more visible, they never told me they were releasing a new version. They never mentioned to me what they had updated. In their minds, they hadn’t updated much. A few enhancements here and there, but did any of it affect the help? They didn’t know because frankly, they probably never read the help. In their minds, help had been checked off the list weeks ago. There was no need to revisit it. Besides, they were mostly working on bugs and fixes, not new use cases. When I learned, through a general department meeting, that a new version of the application was being released in a week, I scrambled back into the application to find out what had changed. As I moved from topic to topic through my help and the interface, I spent the next 30 hours making updates to the help content. I had to scrap all of my videos, as they were no longer accurate. I added some new topics, removed others. Fundamental terminology changed, and new functionality had been added. As I sat there updating the documentation against the clock, I could hardly believe I hadn’t been notified. C’mon, were they really going to release this without telling me what needed to be updated in the help? I was a bit upset for a few days, but under too much pressure to really think through the why of the situation. Instead, I was heads-down, hands on the keyboard, frantically making updates and logging bugs and trying to fix things before they shipped it out the door. Though I tried not to think this way, I started to resent the project manager a bit. I had rarely been invited to a project meeting or scrum. I had to persuade the project manager that their app needed comprehensive help in the first place. Wasn’t the project manager savvy enough to know that with each update to the interface and functionality, the help needed to also be updated? This is a situation you’ve probably run through dozens of times. Once early in my career something like this happened — the interface kept changing on me, and no one ever informed me about the changes. One of my senior colleagues looked at me and said, with a smug look on her face, “Welcome to our world.” In those early days as well as the other week, when I experienced developer neglect and suffered a lack of information, I felt marginalized. I tasted the second-class citizenship status that so often takes place in IT organizations with technical writers. The tech writer is the last to know about interface updates, if anyone even bothers to let him or her know. The perception of information exclusion, whether real or not, is so common among technical writers that it might even be classified under as a complex. If you suffer from an information exclusion complex, you’re disgruntled at project teams for not telling you the information you need to do your job correctly. The project’s information door has been shut on you, and you must kick your foot under the door to wedge it open. Well, I have started to figure out how developers tick, and I recently discovered something that has helped me break free from my information exclusion complex. How Developers TickI didn’t piece this together all at once, and it is still a picture that is forming in my mind, but it’s compelling. At the heart of how developers, quality assurance (QA) engineers, and project managers interact is through a bug/enhancement tracking system called JIRA. In your organization it may be something else, but the concept will likely be the same. In my organization, every time QA engineers find a bug, they log it in JIRA. Every time project managers have an enhancement to the existing functionality, they log it in JIRA. Every time developers fix something, they log it in JIRA. Every change to the application gets logged and tracked in JIRA. The project manager and QA lead assign the items in JIRA to developers. Developers and QA comment on each of the JIRA items, noting challenges or obstacles to the JIRA item. Project managers give each JIRA item a priority level, so that P1s get the most critical attention, while P3s are usually not worked on at all. In short, JIRA stores all of the necessary information for the project. I have simplified things here, because even though all important and changing project information is stored in JIRA, the JIRA system itself is like a maize to navigate. In one of my projects, we have nearly 2,000 items in JIRA, all with various priority levels, version release assignments, sources, dates, comments, and other details. Navigating JIRA can be like looking at a street map of Mexico City and trying to decide where or how to go. Despite the challenges, keeping up with JIRA, I’ve learned, is the key to staying on top of a project. It’s how the developer mind works. Once you understand this, it will help cure all symptoms of the information exclusion complex. If a developer logs something in JIRA, whether it’s a bug, a fix, an enhancement, a user story, or even an update the server the application runs on, he or she expects that everyone else on the project who has access to JIRA will see the update. The developer assumes everyone is as JIRA-savvy and JIRA-driven as he or she is. As technical writers, we often scorn users who are too slow/lazy to read the manual (RTFM). The corollary for developers is to scorn technical writers who are too slow/lazy to read JIRA (RTFJIRA). See how the tables are turned? Leveraging JIRA to Influence ChangesDon’t be intimidated by JIRA, or whatever bug tracking software you use. JIRA is your best friend, because now that you know the secret — that JIRA controls all information about a project — you can start to leverage this information source to influence updates and changes to the application as you see fit. You know that capitalization error on the home page of your app that is driving you nuts? Stop complaining about it in project meetings. Just log it in JIRA and it will probably get done. How about the error message box that says, “Object reference not set to an instance of an object.” You’ve been telling developers for months that no one will understand it. But they aren’t waiting for an email from you to specify how to fix it. No, they’re waiting for the item to appear in JIRA. Like a cook waiting for an order, developers will simply see the request on their screen and get to work. Not every thing you slip into JIRA will get implemented. The tough fixes will be procrastinated, just like you have procrastinated the toughest help topics in your help. When developers feel weary and tired, and when they’re winded from playing too much ping pong, they’ll cherrypick the easy JIRA items that require nothing but simple text updates — your capitalization pet peeves, the label misspellings, those inane on-screen messages that developers typed while they were half-asleep. As long as you stick your requests in JIRA, they will eventually get done. Still a Few SurprisesAlthough I’m following JIRA more carefully now, I still get surprised by project release dates I wasn’t anticipating. But this is only because I fail to check the project items and statuses. Lately, however, I have subscribed to the RSS feeds of the comments and issues in JIRA I want to track. (By the way, RSS Bandit is one of the few RSS readers that can pull authenticated RSS feeds behind your corporate firewall and send you updates when additions are made.) Even if I’m surprised every now and then by unanticipated changes, I’ve completely shed the information exclusion complex. I’m not frustrated if developers don’t tell me about interface and functionality changes. In an agile environment, there’s no way they can keep me updated on an individual level about everything that changes. And I wouldn’t want them tapping on my shoulder all day anyway. I can learn most of what I need to know just sitting in my chair, looking at my screen, submitting new items to JIRA or looking at those JIRA items that have been submitted. Every once in a while I drop by the developers’ desks, but more to say hello than to ask what’s new. Categories: Interesting and Relevant Sites
Add More Sidebars to Your WordPress ThemeYou can add more than one sidebar section to your WordPress site. For example, with the stc-intermountain.org site, I added a whole bunch of additional sidebar sections in the Appearance > Widgets section. Adding more sidebar sections Adding more sidebars is useful if you’re using WordPress more as a content management system than a blog. Someone asked me how I did this. The process isn’t hard. I’ve broken it down into three steps. (Before you continue with the instructions, you may want to back up the information in your existing sidebar.) Step 1Add this code to your functions.php file under Appearance > Editor. if ( function_exists('register_sidebars') ) register_sidebar(array('name'=>'Sidebar Home','before_title'=>'<h4>','after_title'=>'</h4>')); register_sidebar(array('name'=>'Sidebar Jobs','before_title'=>'<h4>','after_title'=>'</h4>')); register_sidebar(array('name'=>'Sidebar Meetings','before_title'=>'<h4>','after_title'=>'</h4>'));In this example, the sidebars that will be added will be called Sidebar Home, Sidebar Jobs, and Sidebar Meetings. Change the names to whatever you want. You can add many more sections here, not just three. You can also add more arguments than simply name, before_title, and after-title. See the full function reference and arguments with registering sidebars. You’ll also need to delete the previous register_sidebars function so that the two don’t conflict. Step 2Add a reference to the sidebar section where you want the sidebar to appear in your theme. For example, type the following to insert the Jobs sidebar: <?php if ( !function_exists('dynamic_sidebar') || !dynamic_sidebar('Sidebar Jobs') ) : ?>To insert the Meetings sidebar, you would type Sidebar Meetings rather than Sidebar Jobs. Step 3In a text editor, duplicate your existing sidebar code, rename the file (for example, sidebar_jobs.php), and FTP the file into the folder with your other theme files. Where you want the file to appear (probably in a specific page template), add this reference to the file: <?php include (TEMPLATEPATH . '/sidebar_jobs.php'); ?>Remove the other code that calls the sidebar (probably get_sidebar). Now that page template will show your Jobs sidebar. And you can configure your Jobs sidebar under Appearance > Widgets. Although I’ve mainly been calling these sections a sidebar, you can create sections and insert them anywhere in your site, such as the footer, an ad space in the header, or elsewhere. Categories: Interesting and Relevant Sites
Using FDK ResourcesFrameMaker,Technical Communication,Adobe Technical Communication Suite,FDK In this blog, we are going to talk about the correct way to use FDK...
Harsh Gupta
Categories: Interesting and Relevant Sites
From The Start We Were Different … An Amazing Video From Mark LogicThis video was used to open the Mark Logic 2009 User Conference. It’s an amazing presentation that tells the story of humans and the paradigm-shifting information explosion we find ourselves in today. When the video ended, the crowd went wild with applause. I’ll have to admit, I’ve never seen such response from an audience, not even to a great presentation delivered by a human opening keynote presenter. Watch the video and let us know what you think. And, consider attending the Mark Logic 2010 User Conference, May 4-6, 2010 in San Francisco. Categories: Individuals, Interesting and Relevant Sites
[Interview] Microsoft’s Gabor Fari on Intelligent Content: Saving Lives By Helping New Drugs Get To Market FasterInterview with Gabor Fari, Microsoft Life Sciences by Scott Abel, The Content Wrangler The Content Wrangler: Hello, Gabor. Tell us a little about yourself and your experience in the content industry. Gabor: I am a Chemical Engineer by training. I became fascinated with software a little over 10 years into my career, before I made the switch to the software industry. To me, building software solutions is still pretty much engineering, and my approach is to build solutions block by block. Gabor Fari, Microsoft Life Sciences I have been working in the enterprise content management industry for over 10 years. I am constantly thinking about how to remove the road blocks to effective content management. Part of the challenges are technology issues, and many of the rest have to do with managing people and change. I am a contributing member of the Document and Records Management SIAC at DIA (Drug Information Association) and the OASIS DITA Pharmaceutical Content Sub-Committee.The Content Wrangler: Where do you work? Tell us a little about your firm, the markets you serve, and the products and services you offer. Intelligent Content Practices and Technologies can help new drugs get to market faster and save lives, Fari says. Gabor: The best example I can think of is in my domain: what if a pharmaceutical company could complete all the documentation necessary to finish a submission to regulatory authorities (a New Drug Application, for example) 6 months faster than they do today using ‘Dumb Content’ approaches. Most importantly, medication could reach the population so much faster. And secondly, consider the competitive advantage a pharmaceutical company would gain by getting to market faster.The Content Wrangler: Are there any examples you can point to of intelligent content on the web? Gabor: I am mostly focused on Intranet applications at the moment, but I have seen a number of ‘Citizen Self-service Portals’ that are applying Intelligent Content approaches to Content-Centric applications such as dynamically generating permits, tax statements etc. The Content Wrangler: Do you know of any useful online resources you think our readers might find useful in understanding intelligent content? Gabor: I would recommend “The Emergence of Intelligent Content” by Joe Gollner and Document Engineering by Robert Glushko and Tim McGrath. The Content Wrangler: Many of our readers might not be that familiar with your products and services, do you have any knowledge resources you’d like them to know about? Gabor: You can keep track of my efforts working with the Microsoft Intelligent Content Framework here. You can also find me on Twitter. Gabor Fari will be presenting a keynote address, Intelligent Content: An Emerging Trend in Enterprise Content Management, at Intelligent Content 2010, February 25-26 in Palm Springs, CA. Categories: Individuals, Interesting and Relevant Sites
Now Everyone Is A Publisher! Are You Ready For The Change?Related Posts:
Categories: Individuals, Interesting and Relevant Sites
Successful Global Content ManagementSuccessful Global Content Management (Webinar) February 18, 2010: 7-8:30pm CET; 6-7:30pm GMT; 1-2:30pm EST; 10-11:30am PST As products move beyond borders the need for global content increases and with that comes the critical requirement for global content management. Global content management allows you to ensure brand consistency, implement a global content strategy, and manage content on a global basis.Management of a single site is a sometimes complex task, but management of multiple global sites is even more complex and requires a well thought out plan, appropriate technology and clear processes. Join The Content Wrangler February 18, 2010 for “Successful Global Content Management”, our free, 90-minute webinar in which content management guru Ann Rockley, The Rockley Group, will share with you the ten steps necessary to launch a successful global content management initiative. You’ll also hear from the CEO of e-Spirit, Joern Bodemann, why content management system usability is a “must have”, not an option. Register tody! Categories: Individuals, Interesting and Relevant Sites
Hump-day Humor 2010-5On-the-job negotiations.Click comic to enlarge it.Michael Hugheshttp://www.blogger.com/profile/06004741387594324547michaelhughesua@gmail.com2
Categories: Interesting and Relevant Sites
What Would a WordPress Template for Chapter Sites Look Like?Last week Will Sansbury mentioned to me that one of his ideas with the Atlanta chapter site was to provide an example or template of how WordPress could be used for chapter sites. I got to thinking, why isn’t there a standard WordPress template for chapters and SIGs to use? Further, in WordPress 3.0, WordPress MU and regular WordPress will be merged. This is huge, because it means you’ll be able to create child blogs with a regular WordPress install. Essentially we could have one site like stcchapter.org with dozens of child blogs, containing subdomains such as intermountain.stcchapter.org, wyoming.stcchapter.org, and so forth. For those chapters that just wanted a simple web solution, they could create a child blog from this site. They could also point their regular domain to the site. The themes and plugins available in child blogs are dependent on what the parent blog chooses to provide. I think the idea of providing a site template from WordPress is ingenious. It made me think about exactly what a chapter WordPress template would look like. I wish I could say our Intermountain-STC site is a perfect example, but it’s not (not yet anyway). I spent a good chunk of time this weekend tweaking a few things. Here are several elements that I think a chapter WordPress template would have. Subpage ListsOne aspect of websites that appeals to me is an apparent simplicity up front. A single navigation bar at the top of the site showing about seven or eight buttons is all I want. Home | About | Blog | Meetings | Jobs | Resources | Events. Something simple. To accommodate this simplicity, the sidebars for each of the pages should show all the subpages for the current page. And here the amount of content in the sidebar can be as abundant as you want, from three page links to thirty or more. The submenu page list hides the complexity. (Fortunately, showing a list of subpages for the current page is simple with the LJ Subpages Widget plugin.) Subpages appear on right for the selected page, allowing you to hide the complexity of information up front and only show the information when a user is on the relevant page Custom SidebarsImplementing custom sidebars feature takes the concept of the subpage lists to another level. Each main page should not only show the subpage list for the current page but also have an entirely unique sidebar showing content specific to that page. Why? Two reasons. If you have the same sidebar content for each page, the reader’s eye becomes blind to it. So even if you have the changing subpage list at the top, the reader may not notice the changing links if the rest of the sidebar remains the same. But if the entire sidebar changes for each of the seven or eight main pages, that’s something you notice. The reader can anticipate that the sidebar content will contain unique content for the specific page he or she is viewing. The sidebars are unique for each page the user is on. For example, with the Jobs page, the user can see information on subscribing to job email alerts and a jobs RSS feed. Second, having a custom sidebar for your page gives you more room to present information for that page in an attractive format. You can give more information to the reader above the fold, without having to scroll. Author Pages Above all else, a chapter site should be collaborative. Multiple chapter members should be able to access it, author content, and publish. You want to highlight and promote the collaborative nature of the site. Posts usually contain a byline, and the byline is a hyperlink to the author’s name that shows the author’s bio and posts. The default author template called is the author.php page, so you can customize this page to show the author’s picture and bio information at the top, like this: Author pages show contact information, profile text, and posts published by the author You can also show a list of authors in your sidebar (see the lower-right section of the image above). Special Widget SectionsOne of the cool things about WordPress is the drag-and-drop widget feature. You drag the widgets you want into the sections on the right. Most people don’t realize that you can create additional sections for your widgets that map to different areas of your templates. For example, you can create 10 or more special sections that correspond with the different pages. This way the people who maintain the site can configure the sidebars without even touching the code. In the following screenshot, you can see that I’ve created a new sidebar section for each of my main pages. You can now drag whatever widgets you want into each of those sections, depending on what you want in the sidebar for that page. This is one way you transform WordPress into a CMS. You can create new sections for your widgets Custom HomepageRather than showing About information or a list of the latest posts, I think the home page best serves its purpose by showing the next chapter meeting, the latest jobs added to the site, the latest blog posts, and general news. The home page of a chapter site should give you a summary of all the important information you may need to know. The home page shows a summary of the most important information These are just my initial thoughts about what a chapter WordPress template might include. I’m currently trying to convert the Intermountain-STC.org site into exactly this template. Any thoughts on what else a chapter or SIG site would need? Categories: Interesting and Relevant Sites
Marking Up The Fab Four: Just Imagine What XML Could Do For Your BooksAlan J Porter [This post is the first in a planned series of articles that examine how the traditional book industry could benefit from adopting XML.] Yesterday I posted on Twitter a couple of figures from the Association of American Publishers report of November 2009 book sales. The good news was that sales overall had in fact increased by 10.9%, but what really stood out was that in November of last year the sales of eBooks exploded showing a 199.9% increase and that they now account for about 2.5% of the revenue generated by book publishing. When you consider that most eBooks are cheaper than their paper equivalents, then the market share based on actual sales numbers is going to be even higher. Sales of the electronic version have out paced hard copy sales 4:1 I’m not sure why I was surprised as the industry figures in some way reflect my own recent experience. Back in September of last year I took the step of offering my biography of the Beatles’ teenage years, “Before They Were Beatles”, as an electronic book on the Kindle. As I no longer had to worry about covering print costs, carrying inventory, processing orders or shipping, I posted the book at a greatly reduced price. Sales of the electronic version have been growing each month, and on average in the last five months sales of the electronic version have out paced hard copy sales by a factor of 4:1.All this sounds great doesn’t it? – On the surface it is, BUT it could be so much more. When I look at my book on the Kindle, or on my iPhone, I am frankly disappointed in it. The reason? eBooks and eBook readers today are little more than simple electronic page turners. eBooks and eBook readers today are little more than simple electronic page turners. But it doesn’t take a lot of imagination to think what they could be like. My book references lots of early recordings of various incarnations of the group that would become The Beatles – wouldn’t it be great to click on a link and actually hear those recordings, or even compare early versions with later versions recorded at the height of their fame. How about when I mention their encounters with other musicians? It would be cool to be able to click on a name and get a snapshot biography, links to books about them and access their music catalog. How about accessing photographs of 1950s Liverpool street scenes, or being able to tour the Fab Four’s childhood homes?And it’s not only non-fiction where I see these sort of enhancements, imagine reading your favorite novelist, and when a character mentions a location being able to click through to the Google street view, or when they eat at a nice restaurant being able to access the recipe. Ever wanted to know exactly how to make the type of vodka martini that is best served shaken, not stirred? It could be just a click away. There is no technical reason why this sort of interactive book couldn’t be done today. As well as being an author of books on various aspects of pop-culture that are published in the traditional model, I’ve also been active in the technical publishing industry for more years than I care to count. Where eBooks and platforms like the Kindle, the Nook, etc. are now is where the technical documentation industry was 15 years ago – simple electronic page turners. But take a look at what large engineering companies, the military, and others are doing with their technical documentation today – they are delivering IETMS (Interactive Electronic Technical Manuals), books with links in the text that can jump you to the related part on an illustration, call up part numbers (even do the automatic ordering of that part for you), or call up animations, video and a whole plethora of supporting information. Technical publications, training, and service departments have been using XML technologies for years to streamline content production processes and to create multiple information products from a single source of content. How is that achieved? Through the use of mark-up languages, and XML (eXtensible Markup Language) in particular. Using XML allows us to tag the content in such a way that the display devices can create links, or so information can be extracted and passed from one system to another.With XML you can not only format the text to look how you want, without having to rewrite or reformat the source each time, but you can use it to automatically generate navigation aids like table of contents, lists of items in the content, indexes, plus all the hyperlinking that adds real value. Over the last few years I’ve offered to write a few books using XML markup, but the publishers have always politely declined, preferring to stick to a system they know. A process that has changed little since the days of the typewriter – yes the tools have changed, but the process is still fundamentally the same; largely because traditional publishers still see the physical book as the product, and not the content. But today content is king, and we need to make that content available across all platforms, and to be able to add value to it, and that means mark-up. [In the next post I’ll compare the differences in the workflow between traditional publishing and technical publishing and look at how the cost of moving to XML is a lot less than most publishers believe.] About the Author Alan J. Porter a 20 year veteran of the corporate communications industry is founder of 4Js Group LLC a consulting and services company that specializes in combining creative talent with business expertise to help companies tell their story. He is also the regular writer of the monthly Disney*Pixar “World of CARS” comic book series. His latest book, “WIKI: Grow Your Own for Fun and Profit” will be published by XML Press in May 2010. Blog: THE CONTENT POOL http://4jsgroup.blogspot.com Categories: Individuals, Interesting and Relevant Sites
Reimagining the Book Publishing World With XMLBy Dev Ganesan, President and CEO of Aptara Dev Ganesan, President and CEO, Aptara Today’s content consumers are voracious digital omnivores, desiring to feed on all types of electronic content — from Twitter tweets to YouTube videos, from iPhone apps to Facebook updates, from mp3s to eBooks. Yet traditional publishers, particularly trade book publishers, are not prepared to serve digitally savvy audiences the variety of electronic products they demand. That’s because their production processes are traditionally rooted in outdated print publishing practices that are severely inadequate for tackling today’s publishing challenges.In order to profit – literally – from the new digital markets, publishers must rethink the way they create, manage, publish, and deliver content. They must re-engineer their processes to create more flexibility and guarantee a sustainable and certain future. They must re-imagine a production process that frees their content to be transformed — on-demand — into whatever new formats, devices, and uses consumers require, now and for the future. Continuing to retrofit existing print-based content workflows is not only impractical, overly expensive, error-prone, and unnecessarily complicated, it’s also not an efficient, flexible, or sustainable business practice. Fred Ciporen, former publisher of Publishers Weekly, recently echoed similar sentiments to an industry group preparing for the American Library Association Mid-Winter Conference. To become lean and robust, publishers have to recognize the shortcomings of undertaking each new publishing challenge from scratch. For example, considering eBook creation as a project at the end of the print publishing lifecycle artificially and exponentially increases production costs. Continuing such practices misses the essential benefits of digitization. It condemns the company to the past, forgoing the future while ignoring consumer demand. Freeing content from formatting and making it possible to easily deliver content to any device on any platform in any format—print, web, or mobile—is not a new idea. Organizations have been doing it for years through leveraging the power of XML. “It’s both surprising and ironic that trade publishers, in particular, have yet to adopt XML-first or XML-centric workflows,” said Fred Ciporen. It’s time for traditional publishers to follow suit − with a content-centered XML-first publishing approach. Getting there is not the difficult or disruptive process that many publishing executives have assumed. For instance, innovative new authoring tools enable content to be created in XML using interfaces indistinguishable from Microsoft Word. (XML is an open content standard that drastically reduces the effort required of publishing houses to create eBooks — and every other type of content. XML is designed to help publishers break the dependency of content on proprietary formats and specific devices. XML content can be easily repurposed, reused, shared, sorted, aggregated with other content, and automatically processed, published, and delivered, often on-demand.)“Fortune 1000 companies have been adopting XML publishing not because it’s cool and trendy, but because doing so saves them millions of dollars and provides measurable benefits,” says content management guru Ann Rockley. “It’s seen as a competitive advantage; an approach designed to help publishers respond quickly to both new business opportunities and threats from competitors.” Note: See Managing Enterprise Content: A Unified Content Strategy by Ann Rockley, Pamela Kostur and Steve Manning (New Riders Publishing) for details on how to plan for and implement a content-first strategy. Technical communications departments in the aerospace, automotive, manufacturing, life sciences, financial, and publishing industries use a content-first XML publishing approach to create, publish, and deliver their own version of books: product-specific user guides, product manuals, support Web sites, and online help systems from a single repository of content, thanks to XML. Corporate training departments and universities use the same methods to create role-specific XML-based training and eLearning content. Some publishers may be surprised to learn that their own organizations are already using this approach to create in-house documentation and training materials. Though there are few examples of Trade publishers adopting XML-first workflows, below are two examples of Educational publishing houses that are thinking creatively and benefiting: John Wiley & Sons has re-engineered their approach to publishing with the advent of Wiley Custom Select, an online portal that provides educators with the ability to create their own custom text books. Teachers select content they desire from any of the products in the Wiley library, arrange it in the order they desire, upload their own content (should they desire to do so), and, with a few clicks, automatically format, publish, and deliver the content into a custom eBook. All of this is made possible using XML. O’Reilly Media and the Pearson Technology Group joined forces to create Safari Books Online. The premise was simple: compile the best technology books from the leading authors and publishers into an on-demand digital library that technology, digital media, and creative professionals could quickly and easily search for reliable, definitive answers to mission-critical questions. Content downloaded from Safari Books Online is optimized for mobile devices, computers, or other reading devices, and many titles are available as eBooks. All of this is also made possible through XML. “It’s both surprising and ironic that trade publishers, in particular, have yet to adopt XML-first or XML-centric workflows,” said Fred Ciporen. “Surprising, because they have the most to gain from re-engineering their publishing approaches, and ironic because their titles and products are more ideally suited for such workflows than most other types of publications.” The benefits to the publisher — and the reader — are many, including:
Categories: Individuals, Interesting and Relevant Sites
Fragmented Communities and the Chapter/SIG Web Site ProblemRecently Will Sansbury and I gave a webinar to STC community leaders on chapter and SIG websites. Rather than giving a static, one-way presentation about theoretical concepts with web design, or boring people with technical details they probably didn’t care about, we held the webinar more like a design review workshop, not too different from a writing group workshop. Although I spent three years in a creative writing program holding exactly these types of writing workshops, in which a group of people provide feedback on the story or essay someone submits, it never crossed my mind that designers probably sit around tables doing the exact same thing with websites. Design ReviewsRegardless of the topic, the methodology of the workshop is mostly the same. In a tactful way, you explain what works well and what could be improved. Others either agree or disagree with your analysis, and hopefully they explain why. The only difference between critiquing creative stories and websites is in the questions you ask. Rather than ask, what’s the story here? Are the characters believable? Does it have arc? You ask questions about findability, simplicity, readability, and so forth. I found that in looking at websites, my feedback could be grouped into about seven categories: Purpose
Findability
Simplicity
Readability
Interactivity
Content Appeal
Design Appeal
For more on running a design review, see Scott Oberkun’s How to Run a Design Critique and Makiko Itho’s The Delicate Art of (Web) Design Critique. Trends from the AnalysisIf you go through each of these categories, you usually find something worthwhile to say. We analyzed six different sites: Quality Process SIG, Twin Cities, Heartland, Tech Editing SIG, Orlando, and the Contracting and Independent Consulting SIG. The webinar description suggested that we would explore ways to build attractive online sites where members could interact and find value, because fewer and fewer people are physically gathering for meetings. As we moved through the sites, it was clear that a lot of people were trying to move in exactly this direction — towards collaboration and participation. The Quality Process SIG adopted SharePoint to make it easy for numerous people to author content. Twin Cites integrated a social networking component in a custom CMS where members could friend each other, add personal details, and even write blog posts. Orlando was in the process of moving their content to WordPress because their old site was a “dinosaur.” The Tech Editing SIG built their content on a wiki platform containing a section that showed posts from their email list discussions in an automated way. What’s MissingTo enable participation and collaboration, many of the platforms allowed you to comment, subscribe, interact, log in, and manage the content. This makes sense. But the platform is only the first step. Whether you’re using WordPress, Drupal, Joomla, SharePoint, Ning, or any other Web 2.0-capable technology, a larger ingredient is missing from the recipe for a thriving online site where members naturally gravitate to for interaction. Your site can be as interactive as anything can be, and yet still remain dormant, unused, unexplored, rarely visited, and rarely even noticed unless you provide a reason for people to come together as a community. For example, although the Twin Cities site offers the ability to friend others, blog, and add personal details about your location, interests, and other details, it isn’t generating the activity you see on Facebook. What’s interesting about Facebook isn’t that it allows you to write on other people’s walls, provide status updates, or add other people as friends. What’s interesting is that so many people are on Facebook, checking it and posting to it daily or even hourly. Is it possible to create an online platform that technical communicators would use with as much popularity as Facebook or Twitter or even Stack Overflow? The problem, I think, is in gathering a critical mass of community. Chapters are so small, it’s hard to see much activity from members on a site. For example, our chapter now has about 20 members (as opposed to about 75 from last year). To think we’ll convert the site into a thriving hub of online interaction is an illusion. You need thousands of people to build up the exchanges that take place in a popular community. When you have the thousands of people coming to your site every day, they begin to interact, and the interactions fuel more comments and replies and posts. At some point, you have a thriving community. But you don’t build a community without a critical mass of participation. Without a critical mass of people to form a community, you end up with a dormant-looking site — for example, what most chapter sites look like. The Ning Community Scott Abel created comes closest to the thriving online site where members can interact, but even that site seems underused. I just logged into the other day for the first time in months. Again, the main problem is in the critical mass. There just aren’t enough people in chapters to form a presence on a site. Chapters and SIGs fragment the already small online technical communicator audience. Additionally, although SIGs have greater potential for online interaction, most of the activity is often better expressed through e-mail listservs and threaded forum discussions. As old-school as email or forums are, they’re fast, immediate, and reach almost everyone. The Solution?I’m not really sure what solution is for chapter and SIG sites to move from dormant sites to thriving hubs of interaction. Technical writers are a small niche of overall people on the web, and when you fragment that already small niche into even smaller groups of chapters and SIGs, they never seem to come together in a critical mass of people. This problem isn’t unique to our group. It’s a problem that stems for many independent publishing locations and sites. Conversations are taking place on blogs here and there, email listservs here and there, forums here and there, and the consequence is a bunch of whispers that you can’t hear (unless you look in each of the individual places). I believe the solution won’t involve centralizing the information/people into one site and location. Instead, it will involve aggregating the sources through RSS and other technology. Categories: Interesting and Relevant Sites
Free Localization Conference February 9-10: SDL Innovate 2010 – Strategies for Delivering Content and Products to Global MarketsJoin us at SDL Innovate 2010: Strategies for Delivering Content and Products to Global Markets in Santa Clara, CA – February 9-10. Learn about localization, translation, internationalization, structured content, global multi-channel marketing, and attend half a dozen sessions dedicated to the Darwin Information Typing Architecture (DITA). Join us. It’s free! We like free. Categories: Individuals, Interesting and Relevant Sites
SharePoint: ‘Forcing It To Fit’ Is An Expensive And Painful ExperienceBy Scott Smith, Invisible Fist Each time I’ve sat down to write about Microsoft SharePoint, I’ve experienced a sensation that is the polar opposite of writer’s block. Indeed, there is much to say about SharePoint. The current ‘deluxe’ edition, (Microsoft Office SharePoint Server aka MOSS), is a big, feature-rich solution, developed by a gigantic company that has bankrolled an aggressive marketing campaign. Additionally, there are many Microsoft partners and bloggers helping to spread the SharePoint gospel. There is also a proportionally large population of SharePoint detractors and companies that profess to offer solutions that rival those of MOSS. Some time ago, after decades of experience with the Macintosh, and several years in supporting Unix systems, I found myself working for a Microsoft development partner. Thus, I can assure you that I have already received my life’s ration of SharePoint hype. I have also seen a fair amount of unwarranted criticism of SharePoint. Neither unbridled praise nor baseless criticism are helpful, if you, the content specialist, or your clients are considering SharePoint as a possible solution. To add another layer of confusion, Microsoft is scheduled to release a new version, SharePoint 2010. this year. We’re already seeing a fresh wave of SharePoint hype, and SharePoint hate. In this article
I’ll explore SharePoint, attempt to reduce your uncertainty about the product, and help you understand what it means for the content manager. As stated, SharePoint is a gargantuan solution, this article is merely a flyover of SharePoint’s features and functionality. Though there is new version of SharePoint forthcoming, this article’s focus is on MOSS, with some discussion of other members of the SharePoint family, including commentary on the new SharePoint 2010. Really Brief Background on SharePoint’s Genealogy Some of the confusion surrounding SharePoint is natural because there are several different flavors of SharePoint. I won’t go through the entire family tree, but I do want to clarify that there is a version of SharePoint that was bundled with Windows Server operating systems. This is known as Windows SharePoint Services (WSS). WSS offers some basic portal and document-management services at no additional charge to owners of the Windows Server license. MOSS, released in 2007, is an amalgam of several key Microsoft server technologies, including:
MOSS provides the same collaborative technologies as WSS, with value-adds including web content publishing. The ‘Enterprise” edition of MOSS provides enhanced search capabilities, and the means to extract content from legacy systems. What Does MOSS Do? When asked what MOSS can do, without hesitation, I can honestly say that “MOSS can do a whole lot of things.” There are indeed many things that MOSS does pretty well out-of-the-box. Additionally, there are things that it can do reasonably well with minor configurations. Finally, there are attributes of MOSS that are probably not going to be on par with your expectations. While desired functionality might be achieved with custom development, this may not be the most cost-effective tactic for you or your clients. The glut of literature making claims about MOSS is highly confusing. You may have encountered articles and blogs that profess that MOSS provides:
While each of the above descriptors are technically true (errr, possible), such labeling is of little value as you consider solutions to your communications challenges. Let me boil it down to this: MOSS is a content management system. With every digital photo, every key stroke…you are making content. At issue is whether MOSS can manage your content types and whether it can do so in a manner that meets with your needs. I realize that content management (CM) is a term that is rather elusive in its own right. So, to provide some structure to our conversation about MOSS, I offer this rather simplistic definition of CM: Content management is about who gets, what, when and how in an organization. My fellow political science minors might recognize the inspiration of this definition: the scholar Harold Lasswell. Essentially any content management solution should address the following organizational challenges:
MOSS security: Who gets your content? The MOSS security model is a bit confusing at first glance (and probably second glance, too), but with proper planning, an organization can make its content as open, or as restricted, as it chooses. By default, content access requires that users be authenticated; however, MOSS allows for anonymous access configuration. This permits content to be made available outside the organization, as in the case of a public website. A deep-dive of security is beyond the scope of this article; thus let it suffice to say that SharePoint offers a range of user roles from full control to read-only access and that can be applied globally or to individual content items. MOSS content creation, repurposing and transformation: What content can they get? MOSS pages are built upon Microsoft’s ASP.Net framework, thus they support bundles of reusable code known as Web Parts. Similar to components (portlets, widgets, gadgets…) that you may have used with other content management systems, Web Parts enable eligible users to create or aggregate content on a MOSS Page. MOSS also provides the capability to create many types of document libraries, as well as lists — things like calendars and announcements — that you can embed directly in a page, the same way that you would do with a Web Part. Some of the types of content that you can manage and deliver with MOSS include:
With base-level configurations, you also will have some ability to convert content, on-the-fly, from one format to another. However, you will only be able to convert content from one Microsoft Office format to another, or to HTML MOSS content publishing and workflow: When can they get the content? One of the key challenges to an organization is that content is made available when, and only when, it is approved for public consumption. It’s surprising how often workflow is accomplished manually in some organizations. For example, content might be routed–through e-mails, or printed pages–for approval before the ‘final’ version is sent to a web specialist tasked with “adding it to the site.” MOSS can help to automate this process. MOSS has features to ensure that content has gone through proper quality control before it is available to end users. This includes content status (‘draft’ vs. ‘published’ states) and approval workflow. Content creators (and site administrators) can see sites and documents when they are in a ‘draft’ state, but end users can only see the content when it has been approved and published. MOSS provides content-approval workflow capabilities out-of-the-box. These are rather simplistic, but fit the needs of many organizations. A MOSS workflow requires that content be ‘approved’ by an eligible user (an administrator or approver) before it can be viewed by end users. In the event that more complex workflows (integrating with other information systems, for example) are required, MOSS allows for workflow customization. MOSS fulfillment: How do they get the content? There are an array of methods by which users can find content in MOSS, but the primary means are browsing and search. Users who are familiar with the site’s taxonomy, or are intrepid clickers, can browse to a specific page, where they might download a document or view calendar items. Others may rely on MOSS search functionality to return results based on users’ input. MOSS search service will index all of your site content, including documents housed in your libraries. You will also have the ability to index documents on your file servers. This is a handy feature because you will have access to a robust document search — even if documents have not yet been migrated to a MOSS document library. MOSS’s search service can index external content that can is available via the Internet. Thus, you can configure MOSS search service to index public-facing websites that are relevant to your users. Strengths Some key areas in which MOSS excels:
Some Drawbacks Some areas where SharePoint is lacking:
Overcoming MOSS Obstacles A lot of people are using MOSS. This isn’t an attempt to get you to succumb to peer pressure, but it does mean that a lot support (people, products and solutions) is available. To paraphrase The X-Files, the truth is (probably) out there. Some reasons that MOSS may still be a possibility for you even if it comes up short out-of-the-box:
Coming Attractions A major upgrade of SharePoint is due to be released this year – I haven’t actually taken SharePoint 2010 for a spin yet, but in the final version you can expect:
Key Questions Regarding SharePoint
I can, however, offer a few guidelines for a SharePoint project:
SharePoint is a growing force in the content management industry. As discussed it offers many ways to create and deliver content within the confines of a single organization or throughout the world. And despite weaknesses in some key areas, its presence is buttressed by a huge development community and numerous commercial software vendors offering solutions to extend SharePoint’s functionality. It’s hard to ignore. However, it is important that content experts be able to separate SharePoint’s functionality from SharePoint hype in evaluating content management solutions. SharePoint is not for everybody. Forcing SharePoint to fit in an organization is painful, and costly. Learn more About the Author Scott Smith offers 20 years of experience in the creation and delivery of content. His professional service includes production-team leadership, web consulting and management of digital assets of all forms. In recent years Scott has gained an extensive knowledge of Microsoft Office SharePoint Server (MOSS). Scott is especially interested in extending SharePoint’s functionality to include robust digital asset management (DAM) and e-learning. He has experience in an array of contexts, including publishing and advertising, IT, web consulting, K-16 education and biotechnology. Scott is currently working on his capstone project in fulfillment of his master’s degree in educational technology at Western Michigan University. The project will involve the design of a learning-management solution to facilitate the creation and delivery of accessible content for educational and commercial contexts. You can learn more about Scott, here. Categories: Individuals, Interesting and Relevant Sites
How The iPad Is Going To Change The Way We Do Things EverydayCategories: Individuals, Interesting and Relevant Sites
[Parody] Mad TV Predicted the iPad Long Before Anyone Else Did
Related Posts:
Categories: Individuals, Interesting and Relevant Sites
Apple iPad Launch
Related Posts:
Categories: Individuals, Interesting and Relevant Sites
New award, and a cry for help!My NSS award goes collectively to all of the accessibility web sites on colorblindness that advised me to offer an alternative to using color to convey meaning.An open question for my readers:If an IP address in red means one thing and an IP address in blue means something else, what alternative approach would you recommend for this kind of scenario?Michael Hugheshttp://www.blogger.com/profile/06004741387594324547michaelhughesua@gmail.com6
Categories: Interesting and Relevant Sites
|
User loginMost Popular Tags on the TECHWR-L SiteGet Answers FastWe readSearchPollRecent blog posts
Live on TECHWR-L
|